Views¶

Module contents¶

Submodules¶

django_mri.views.defaults module¶

class django_mri.views.defaults.DefaultsMixin¶

Bases: object

Default settings for view authentication, permissions and filtering.

authentication_classes = (<class 'rest_framework.authentication.BasicAuthentication'>, <class 'rest_framework.authentication.TokenAuthentication'>)¶

filter_backends = (<class 'django_filters.rest_framework.backends.DjangoFilterBackend'>, <class 'rest_framework.filters.SearchFilter'>, <class 'rest_framework.filters.OrderingFilter'>)¶

permission_classes = (<class 'rest_framework.permissions.IsAuthenticated'>,)¶

django_mri.views.nifti module¶

class django_mri.views.nifti.NiftiViewSet(**kwargs)¶

Bases: django_mri.views.defaults.DefaultsMixin, rest_framework.viewsets.ModelViewSet

pagination_class¶: alias of django_mri.views.pagination.StandardResultsSetPagination

queryset¶

serializer_class¶: alias of django_mri.serializers.nifti.NiftiSerializer

django_mri.views.pagination module¶

class django_mri.views.pagination.StandardResultsSetPagination¶

Bases: rest_framework.pagination.PageNumberPagination

Default pagination parameters. This didn’t work as part of the DefaultsMixin and therefore has to be defined separately in the ‘pagination_class’ configuration.

page_size = 25¶

page_size_query_param = 'page_size'¶

django_mri.views.scan module¶

class django_mri.views.scan.ScanViewSet(**kwargs)¶

Bases: django_mri.views.defaults.DefaultsMixin, rest_framework.viewsets.ModelViewSet

API endpoint that allows scans to be viewed or edited.

filter_class¶: alias of django_mri.filters.scan_filter.ScanFilter

from_dicom(request: rest_framework.request.Request, series_id: int = None) → rest_framework.response.Response¶

Returns scan information from a Series instance without serializing.

Parameters:	request – A request from the client. series_id (int, optional) – `Series` primary key, by default None
Returns:	Serialized data or messagerequirements
Return type:	Response

get_queryset() → django.db.models.query.QuerySet¶

Filter the returned scans according to the studies the requesting user is a collaborator in, unless the user is staff, in which case return all scans.

Returns:	Scan instances.
Return type:	QuerySet

ordering_fields = ('id', 'description', 'number', 'created', 'echo_time', 'inversion_time', 'repetition_time', 'sequence_type', 'spatial_resolution', 'institution_name')¶

pagination_class¶: alias of django_mri.views.pagination.StandardResultsSetPagination

plot(request: rest_framework.request.Request, pk: int = None) → rest_framework.response.Response¶

preview_script(request: rest_framework.request.Request, pk: int = None) → rest_framework.response.Response¶

queryset¶

search_fields = ('id', 'description', 'number', 'created', 'scan_time', 'echo_time', 'inversion_time', 'repetition_time', 'sequence_type', 'spatial_resolution', 'institution_name', 'is_updated_from_dicom')¶

serializer_class¶: alias of django_mri.serializers.scan.ScanSerializer

django_mri.views.sequence_type module¶

class django_mri.views.sequence_type.SequenceTypeViewSet(**kwargs)¶

Bases: django_mri.views.defaults.DefaultsMixin, rest_framework.viewsets.ModelViewSet

pagination_class¶: alias of django_mri.views.pagination.StandardResultsSetPagination

queryset¶

serializer_class¶: alias of django_mri.serializers.sequence_type.SequenceTypeSerializer

django_mri.views.utils module¶

django_mri.views.utils.fix_bokeh_script(html: str, destination_id: str = 'bk-app') → str¶