OrsPlugins

orsdicomloader

Plugin used to load DICOM files

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:e8712846762511e790fb448a5b5d70c0

class OrsPlugins.orsdicomloader.OrsDICOMLoader(varname=None, managed=True)

lib = None

libName = 'OrsDICOMLoader.dll'

startGui()

orsimageloader

Plugin used to load image files

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:396311c8762611e7879a448a5b5d70c0

class OrsPlugins.orsimageloader.OrsImageLoader(varname=None, managed=True)

classmethod OpenUIOnRecentFileEntry(entry)

Helper interface to start the gui, prepopulating the files list :param entry: a saved recent file entry :return: None

classmethod StartGuiWithFiles(stringifiedFiles='')

createCroppedDatasetDeterminingGeometryFromFiles(fileNames, minX, maxX, minY, maxY, minZ, maxZ)

createCroppedDatasetDeterminingGeometryFromFolderContents(folderPath, searchFilter, minX, maxX, minY, maxY, minZ, maxZ)

interfacemethod createDatasetDeterminingGeometryFromFiles(fileNames)

Creates a dataset from a set of files.

Parameters:fileNames (file) [count=[0, None]] – fully qualified file names Returns:output (ORSModel.ors.Channel) [count=1] – Created dataset

createDatasetDeterminingGeometryFromFolderContents(folderPath, searchFilter)

interfacemethod createDatasetFromFiles(fileNames, xSize, ySize, zSize, tSize, minX, maxX, minY, maxY, minZ, maxZ, xSampling, ySampling, zSampling, tSampling, xSpacing, ySpacing, zSpacing, slope, offset, dataUnit, invertX, invertY, invertZ, axesTransformation, datasetName, convertFrom32To16bits, dataRangeMin, dataRangeMax, frameCount)

Creates a dataset from a set of files.

Parameters:

• fileNames (file) [count=[0, None]] – fully qualified file names
• xSize (int) – X size
• ySize (int) – Y size
• zSize (int) – Z size
• tSize (int) – T size
• minX (int) – lower X index (for cropping)
• maxX (int) – upper X index (for cropping)
• minY (int) – lower Y index (for cropping)
• maxY (int) – upper Y index (for cropping)
• minZ (int) – lower Z index (for cropping)
• maxZ (int) – upper Z index (for cropping)
• xSampling (int) – sampling in X
• ySampling (int) – sampling in Y
• zSampling (int) – sampling in Z
• tSampling (int) – sampling in T
• xSpacing (float) – X spacing (in meters)
• ySpacing (float) – Y spacing (in meters)
• zSpacing (float) – Z spacing (in meters)
• slope (float) –
• offset (float) –
• dataUnit (str) – unit of the data
• invertX (bool) – True to invert the X axis
• invertY (bool) – True to invert the Y axis
• invertZ (bool) – True to invert the Z axis
• axesTransformation (int) – 0-> XYZ, 1->XZY, 2->YXZ, 3->YZX, 4->ZXY, 5->ZYX
• datasetName (str) – name of created dataset
• convertFrom32To16bits (bool) – True to convert from 32 bits to 16
• dataRangeMin (float) – minimum of data range
• dataRangeMax (float) – maximum of data range
• frameCount (int) – number of frames

Returns:

output (ORSModel.ors.Channel) [count=[0, None]] – Created dataset

interfacemethod createDatasetFromRAWFiles(fileNames, xSize, ySize, zSize, tSize, type, reverseByteOrdering, signedData, dataOffset, minX, maxX, minY, maxY, minZ, maxZ, xSampling, ySampling, zSampling, tSampling, xSpacing, ySpacing, zSpacing, slope, offset, dataUnit, invertX, invertY, invertZ, axesTransformation, datasetName)

Creates a dataset from a set of RAW files.

Parameters:

• fileNames (file) [count=[0, None]] – fully qualified file names
• xSize (int) – X size
• ySize (int) – Y size
• zSize (int) – Z size
• tSize (int) – T size
• type (int) – 0->unsigned byte, 1->unsigned short, 2->unsigned int, 3->float
• reverseByteOrdering (int) –
• signedData (int) –
• dataOffset (int) – offset into the file where the data begins (for files that have a header)
• minX (int) – lower X index (for cropping)
• maxX (int) – upper X index (for cropping)
• minY (int) – lower Y index (for cropping)
• maxY (int) – upper Y index (for cropping)
• minZ (int) – lower Z index (for cropping)
• maxZ (int) – upper Z index (for cropping)
• xSampling (int) – sampling in X
• ySampling (int) – sampling in Y
• zSampling (int) – sampling in Z
• tSampling (int) – sampling in T
• xSpacing (float) – X spacing (in meters)
• ySpacing (float) – Y spacing (in meters)
• zSpacing (float) – Z spacing (in meters)
• slope (float) –
• offset (float) –
• dataUnit (str) – unit of the data
• invertX (int) – True to invert the X axis
• invertY (int) – True to invert the Y axis
• invertZ (int) – True to invert the Z axis
• axesTransformation (int) – 0-> XYZ, 1->XZY, 2->YXZ, 3->YZX, 4->ZXY, 5->ZYX
• datasetName (str) – name of created dataset

Returns:

output (ORSModel.ors.Channel) [count=[0, None]] – Created dataset

createImagesFromFiles(fileNames)

lib = None

libName = 'OrsImageLoader.dll'

openUIOnFiles(stringifiedFileNames)

openUIOnRecentFileEntry(entry)

populateImageFromFile(image=None, filename=None)

startGui()

orsimagesaver

Plugin used to save image files

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:2e2f8cd2762711e79e3c448a5b5d70c0

class OrsPlugins.orsimagesaver.OrsImageSaver(varname=None, managed=True)

exportDatasetToFile(dataset, fileName, outputType, showProgress)

exportDatasetToGDT1(dataset, fileName)

exportDatasetToJpegFile(dataset, fileName, imageQuality, showProgress)

exportDatasetToTiffFile(dataset, fileName, useLZWCompression, exportMultiFrameFile, showProgress)

exportImageToFile(image, fileName)

This is the official interface to export an image (scriptable) :param image: an ORS::Image :param fileName: fully qualified file name :return: True if succeeded, False otherwise

lib = None

libName = 'OrsImageSaver.dll'

startGuiForDataset(datasetGUID)

orsmeshloader

Plugin used to load mesh files

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:3e44f376762711e79f3c448a5b5d70c0

class OrsPlugins.orsmeshloader.OrsMeshLoader(varname=None, managed=True)

classmethod OpenUIOnRecentFileEntry(entry)

Helper interface to start the gui, prepopulating the files list :param entry: a saved recent file entry :return: None

lib = None

libName = 'OrsMeshLoader.dll'

loadMeshFromFile(filename, showProgress, outputMesh)

openUIOnRecentFileEntry(entry)

Helper interface to start the gui, prepopulating the files list :param entry: a saved recent file entry :return: None

startGui()

orsmeshsaver

Plugin used to save mesh files

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:64c8741e762711e7a9b1448a5b5d70c0

class OrsPlugins.orsmeshsaver.OrsMeshSaver(varname=None, managed=True)

exportMeshToFile(dataset, filename)

lib = None

libName = 'OrsMeshSaver.dll'

startGuiForDataset(datasetGUID)

orspreferences

Plugin managing the user preferences

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:76e108c0762711e79e58448a5b5d70c0

class OrsPlugins.orspreferences.OrsPreferences(varname=None, managed=True)

lib = None

libName = 'OrsPreferences.dll'

orsqtemptyloader

Plugin used to create a dataset

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:8ac6fda4762711e78298448a5b5d70c0

class OrsPlugins.orsqtemptyloader.OrsQtEmptyLoader(varname=None, managed=True)

interfacemethod createChannel(title, dataType, sizeX, sizeY, sizeZ, sizeT, spacingX, spacingY, spacingZ, offset, slope, addNoise, gaussian, noiseStdDev, noiseRatio, initValue, progress)

Creates a dataset from parameters.

Parameters:

• title (str) – title of the dataset
• dataType (int) – data type. 0: unsigned byte; 2: unsigned short; 4: unsigned int; 6: float.
• sizeX (int) – X size
• sizeY (int) – Y size
• sizeZ (int) – Z size
• sizeT (int) – T size
• spacingX (float) – X spacing (in meters)
• spacingY (float) – Y spacing (in meters)
• spacingZ (float) – Z spacing (in meters)
• offset (float) –
• slope (float) –
• addNoise (bool) – if True, noise will be added
• gaussian (bool) – if True, the added noise will have a gaussian distribution
• noiseStdDev (float) – noise standard deviation
• noiseRatio (float) – ratio of noise
• initValue (float) – initial value put in each voxel
• progress (str) – id of a progress object

Returns:

output (ORSModel.ors.Channel) [count=1] – Created dataset

lib = None

libName = 'OrsQtEmptyLoader.dll'

startGui()

orsqthelp

Plugin for the Help information

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:d66b0064762711e78289448a5b5d70c0

class OrsPlugins.orsqthelp.OrsQtHelp(varname=None, managed=True)

lib = None

libName = 'OrsQtHelp.dll'

orsqtlayout

Plugin managing the disposition of the views

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:f3b5d226762711e78923448a5b5d70c0

class OrsPlugins.orsqtlayout.OrsQtLayout(varname=None, managed=True)

addMovieKeyFrame(timeFrame)

classmethod addMovieKeyFrameActionCall()

interfacemethod addMovieKeyFrameInCurrentView(timeFrame=-1)

Adds a key frame to the Movie Maker for the current selected view

Parameters:timeFrame (int) – time of the new key frame. If -1, the new key frame will be appended at the end. Default: -1.

interfacemethod closeMovieMaker()

Closes the Movie Maker

displayCanDisplayAnotherVolume(displayGUID)

enableSeriesLayoutControls(bEnable)

getFrameForAddMovieKeyFrame()

getIsMovieSaverVisibleInCurrentView()

getProperty(visualGUID, displayGUID, propertyName)

isDelayRespectedToCallAddMovieKeyFrame()

isDelayRespectedToCallShowMovieSaver()

lib = None

libName = 'OrsQtLayout.dll'

interfacemethod openMovieMaker()

Opens the Movie Maker

pluginContainsDisplayGUID(displayGUID)

setAxisIndicatorIsShownInCurrentDisplay(bEnable)

setProperty(visualGUID, displayGUID, propertyName, value, applyToAllDisplays, logAction)

showMovieSaver()

Toggles the visibility of the Movie Maker

startServer(address, iPort)

toggleMovieSaverVisibility()

Toggles the visibility of the Movie Maker

classmethod toggleVisibilityMovieSaverInCurrentView()

orsqtmaincontext

Plugin managing the main context of the application

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:1234279e762811e7b42e448a5b5d70c0

class OrsPlugins.orsqtmaincontext.OrsQtMainContext(varName, pushContext=False)

lib = None

libName = 'OrsQtMainContext.dll'

loadWorkspace()

classmethod loadWorkspaceFor(varName)

loadWorkspaceFrom()

classmethod loadWorkspaceFromFor(varName)

resetWorkspace()

classmethod resetWorkspaceFor(varName)

saveWorkspace()

saveWorkspaceAs()

classmethod saveWorkspaceAsFor(varName)

classmethod saveWorkspaceFor(varName)

setState(state)

orsqtplugingenerator

Plugin used to generate the basic files of a new C++ plugins

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:3683c3ca762811e79bdd448a5b5d70c0

class OrsPlugins.orsqtplugingenerator.OrsQtPluginGenerator(varname=None, managed=True)

lib = None

libName = 'OrsQtPluginGenerator.dll'

orsqtpluginviewer

Plugin used to view the details of the imported plugins

author:ORS Team contact:http://theobjects.com email:info@theobjects.com organization:Object Research Systems (ORS), Inc. address:760 St-Paul West, suite 101, Montréal, Québec, Canada, H3C 1M4 copyright:Object Research Systems (ORS), Inc. All rights reserved. date:July 2017 dragonflyVersion:  3.0 UUID:712dea4c762911e79a03448a5b5d70c0

class OrsPlugins.orsqtpluginviewer.OrsQtPluginViewer(varname=None, managed=True)

lib = None

libName = 'OrsQtPluginViewer.dll'