Class SampleDataLogic

Modules/Scripted/SampleData/SampleData.py:518–1233

Manage the slicer.modules.sampleDataSources dictionary. The dictionary keys are categories of sample data sources. The BuiltIn category is managed here. Modules or extensions can register their own sample data by creating instances of the SampleDataSource class. These instances sho

class SampleDataLogic:
    """Manage the slicer.modules.sampleDataSources dictionary.
    The dictionary keys are categories of sample data sources.
    The BuiltIn category is managed here.  Modules or extensions can
    register their own sample data by creating instances of the
    SampleDataSource class.  These instances should be stored in a
    list that is assigned to a category following the model
    used in registerBuiltInSampleDataSources below.

    Checksums are expected to be formatted as a string of the form
    ``<algo>:<digest>``. For example, ``SHA256:cc211f0dfd9a05ca3841ce1141b292898b2dd2d3f08286affadf823a7e58df93``.
    """

    @staticmethod
    def registerCustomSampleDataCategory(category, title):
        """Register a sample data category and its display properties.

        Call this before (or independently of) :func:`registerCustomSampleDataSource` to set
        human-readable metadata for a category.

        :param category: Machine-readable category identifier (used as the key in
            ``slicer.modules.sampleDataSources``).
        :param title: Human-readable, translatable category title shown in the SampleData module GUI.
        """
        try:
            slicer.modules.sampleDataSourceCategories
        except AttributeError:
            slicer.modules.sampleDataSourceCategories = {}

        if category not in slicer.modules.sampleDataSourceCategories:
            slicer.modules.sampleDataSourceCategories[category] = {}

        slicer.modules.sampleDataSourceCategories[category]["title"] = title

    @staticmethod
    def registerCustomSampleDataSource(category="Custom",
                                       sampleName=None, uris=None, fileNames=None, nodeNames=None,
                                       customDownloader=None, thumbnailFileName=None,
                                       loadFileTypes=None, loadFiles=None, loadFileProperties={},
                                       checksums=None,
                                       loadFileType=None):
        """Adds custom data sets to SampleData.
        :param category: Section title of data set in SampleData module GUI.
        :param sampleName: Displayed name of data set in SampleData module GUI.
        :param thumbnailFileName: Displayed thumbnail of data set in SampleData module GUI,
        :param uris: Download URL(s).
        :param fileNames: File name(s) that will be loaded.
        :param nodeNames: Node name(s) in the scene.
        :param customDownloader: Custom function for downloading.
        :param loadFileTypes: file format name(s) (if not specified then the default file reader will be used).
        :param loadFiles: Boolean indicating if file(s) should be loaded. By default, the function decides.
        :param loadFileProperties: custom properties passed to the IO plugin.
        :param checksums: Checksum(s) formatted as ``<algo>:<digest>`` to verify the downloaded file(s). For example, ``SHA256:cc211f0dfd9a05ca3841ce1141b292898b2dd2d3f08286affadf823a7e58df93``.
        :param loadFileType: deprecated, use ``loadFileTypes`` instead.
        """

        # For backward compatibility (allow using "loadFileType" instead of "loadFileTypes")
        if (loadFileType is not None) and (loadFileTypes is not None):