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:

list

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

class fastr.resources.datatypes.FilePrefix.FilePrefix(value=None, format_=None)[source]

Bases: fastr.datatypes.URLType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.FilePrefix'
checksum()[source]

Return the checksum of this URL type

Returns:checksum string
Return type:str
description = 'Prefix for another file, including the path'
extension = None

Float Module

class fastr.resources.datatypes.Float.Float(value=None, format_=None)[source]

Bases: fastr.datatypes.ValueType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.Float'
description = 'A floating point value'
value

The value of object instantiation of this DataType.

ITKImageFile Module

class fastr.resources.datatypes.ITKImageFile.ITKImageFile(value=None)[source]

Bases: fastr.datatypes.TypeGroup

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.ITKImageFile'
description = 'Text file to store point coordinates'

Int Module

class fastr.resources.datatypes.Int.Int(value=None, format_=None)[source]

Bases: fastr.datatypes.ValueType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.Int'
description = 'an integer value'
value

The value of object instantiation of this DataType.

JsonFile Module

class fastr.resources.datatypes.JsonFile.JsonFile(value=None, format_=None)[source]

Bases: fastr.datatypes.URLType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.JsonFile'
checksum()[source]

Return the checksum of this URL type

Returns:checksum string
Return type:str
description = 'json file'
extension = 'json'

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:

list

description = 'Meta Image file format'
extension = 'mhd'

NiftiImageFile Module

class fastr.resources.datatypes.NiftiImageFile.NiftiImageFile(value=None)[source]

Bases: fastr.datatypes.TypeGroup

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.NiftiImageFile'
description = 'NiftiTypeGroup'

NiftiImageFileCompressed Module

class fastr.resources.datatypes.NiftiImageFileCompressed.NiftiImageFileCompressed(value=None, format_=None)[source]

Bases: fastr.datatypes.URLType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.NiftiImageFileCompressed'
checksum()[source]

Return the checksum of this URL type

Returns:checksum string
Return type:str
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

class fastr.resources.datatypes.NrrdImageFile.NrrdImageFile(value=None, format_=None)[source]

Bases: fastr.datatypes.URLType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.NrrdImageFile'
description = 'Nrrd Image File format'
extension = 'nrrd'

Number Module

class fastr.resources.datatypes.Number.Number(value=None)[source]

Bases: fastr.datatypes.TypeGroup

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.Number'
description = 'an numeric value'

ProvNFile Module

class fastr.resources.datatypes.ProvNFile.ProvNFile(value=None, format_=None)[source]

Bases: fastr.datatypes.URLType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.ProvNFile'
description = 'Provenance file in the prov N format'
extension = 'provn'

String Module

class fastr.resources.datatypes.String.String(value=None, format_=None)[source]

Bases: fastr.datatypes.ValueType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.String'
description = 'A simple string value'

TifImageFile Module

class fastr.resources.datatypes.TifImageFile.TifImageFile(value=None, format_=None)[source]

Bases: fastr.datatypes.URLType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.TifImageFile'
description = 'Tif Image File format'
extension = ('tiff', 'tif')

TxtFile Module

class fastr.resources.datatypes.TxtFile.TxtFile(value=None, format_=None)[source]

Bases: fastr.datatypes.URLType

__abstractmethods__ = frozenset()
__module__ = 'fastr.resources.datatypes.TxtFile'
description = 'General text file'
extension = 'txt'

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.