datatypes Package¶
datatypes
Package¶
AnalyzeImageFile
Module¶
-
class
fastr.resources.datatypes.AnalyzeImageFile.
AnalyzeImageFile
(value=None, format_=None)[source]¶ Bases:
fastr.datatypes.URLType
-
__abstractmethods__
= frozenset()¶
-
__module__
= 'fastr.resources.datatypes.AnalyzeImageFile'¶
-
classmethod
content
(invalue, outvalue=None)[source]¶ Give the contents of a URLType, this is generally useful for filetypes that consists of multiple files (e.g. AnalyzeImageFile, DICOM). The value will indicate the main file, and the contents function can determine all files that form a single data value.
Parameters: - inval – a value to figure out contents for this type
- outval – the place where the copy should point to
Returns: a list of all files part of the value (e.g. header and data file)
Return type:
-
description
= 'Analyze Image file formate'¶
-
extension
= 'hdr'¶
-
Boolean
Module¶
-
class
fastr.resources.datatypes.Boolean.
Boolean
(value=None, format_=None)[source]¶ Bases:
fastr.datatypes.ValueType
Datatype representing a boolean
-
__abstractmethods__
= frozenset()¶
-
__module__
= 'fastr.resources.datatypes.Boolean'¶
-
__str__
()[source]¶ Returns the string version of the BaseDataType
Returns: string version Return type: str
-
description
= 'A boolean value (True of False)'¶
-
value
¶ The value of object instantiation of this DataType.
-
Directory
Module¶
-
class
fastr.resources.datatypes.Directory.
Directory
(value=None, format_=None)[source]¶ Bases:
fastr.datatypes.URLType
DataType representing a directory.
-
__abstractmethods__
= frozenset()¶
-
__eq__
(other)[source]¶ Directories are equal by default as long as the validatity matches.
Parameters: other (Directory) – other to compare against Returns: equality flag
-
__hash__
= None¶
-
__module__
= 'fastr.resources.datatypes.Directory'¶
-
action
(name)[source]¶ This method makes sure the Directory exists. A Tool can indicate an action that should be called for an Output which will be called before execution.
Parameters: name (str) – name of the action to execute Returns: None
-
description
= 'A directory on the disk'¶
-
extension
= None¶
-
FilePrefix
Module¶
Float
Module¶
ITKImageFile
Module¶
Int
Module¶
JsonFile
Module¶
MetaImageFile
Module¶
-
class
fastr.resources.datatypes.MetaImageFile.
MetaImageFile
(value=None, format_=None)[source]¶ Bases:
fastr.datatypes.URLType
-
__abstractmethods__
= frozenset()¶
-
__eq__
(other)[source]¶ Test the equality of two DataType objects
Parameters: other (URLType) – the object to compare against Returns: flag indicating equality Return type: bool
-
__hash__
= None¶
-
__module__
= 'fastr.resources.datatypes.MetaImageFile'¶
-
checksum
()[source]¶ Return the checksum of this MetaImageFile
Returns: checksum string Return type: str
-
classmethod
content
(invalue, outvalue=None)[source]¶ Give the contents of a URLType, this is generally useful for filetypes that consists of multiple files (e.g. AnalyzeImageFile, DICOM). The value will indicate the main file, and the contents function can determine all files that form a single data value.
Parameters: - inval – a value to figure out contents for this type
- outval – the place where the copy should point to
Returns: a list of all files part of the value (e.g. header and data file)
Return type:
-
description
= 'Meta Image file format'¶
-
extension
= 'mhd'¶
-
NiftiImageFile
Module¶
NiftiImageFileCompressed
Module¶
-
class
fastr.resources.datatypes.NiftiImageFileCompressed.
NiftiImageFileCompressed
(value=None, format_=None)[source]¶ Bases:
fastr.datatypes.URLType
-
__abstractmethods__
= frozenset()¶
-
__module__
= 'fastr.resources.datatypes.NiftiImageFileCompressed'¶
-
description
= 'Compressed Nifti Image File format'¶
-
extension
= 'nii.gz'¶
-
NiftiImageFileUncompressed
Module¶
-
class
fastr.resources.datatypes.NiftiImageFileUncompressed.
NiftiImageFileUncompressed
(value=None, format_=None)[source]¶ Bases:
fastr.datatypes.URLType
-
__abstractmethods__
= frozenset()¶
-
__module__
= 'fastr.resources.datatypes.NiftiImageFileUncompressed'¶
-
description
= 'Nifti Image File format'¶
-
extension
= 'nii'¶
-
NrrdImageFile
Module¶
Number
Module¶
ProvNFile
Module¶
String
Module¶
TifImageFile
Module¶
TxtFile
Module¶
UnsignedInt
Module¶
-
class
fastr.resources.datatypes.UnsignedInt.
UnsignedInt
(value=None, format_=None)[source]¶ Bases:
fastr.datatypes.ValueType
-
__abstractmethods__
= frozenset()¶
-
__module__
= 'fastr.resources.datatypes.UnsignedInt'¶
-
description
= 'an unsigned integer value'¶
-
value
¶ The value of object instantiation of this DataType.
-