Scripting

TableOfContents

Commands

Note that many commands take IDs, such as layerID, collectionID, viewID, toolID, frameID, etc. These IDs are generated when the objects they refer to are created. As input, they must refer to valid objects. If they don't you'll receive an error. All IDs are integers.

Anchor(PrintAllCommands) PrintAllCommands

Anchor(GetLayerIDList) GetLayerIDList

Anchor(SetNumberOfViewMarkers) SetNumberOfViewMarkers numMarkers

Anchor(GetNumberOfViewMarkers) GetNumberOfViewMarkers

Anchor(ExportMarkersToControlPoints) ExportMarkersToControlPoints collectionID fileName

Anchor(ImportMarkersFromControlPoints) ImportMarkersFromControlPoints collectionID fileName

Anchor(SetViewRASCursor) SetViewRASCursor x y z

Anchor(GetViewRASCursor) GetViewRASCursor

Anchor(GetROIIDList) GetROIIDList

Anchor(GetColorLUTIDList) GetColorLUTIDList

Anchor(MakeNewColorLUT) MakeNewColorLUT

Anchor(GetTransformIDList) GetTransformIDList

Anchor(MakeNewTransform) MakeNewTransform

Anchor(MakeLayer) MakeLayer layerType

2DMRI

A layer for drawing a volume

2DMRIS

A layer for showing a surface intersected on a plane

Anchor(DeleteLayer) DeleteLayer layerID

Anchor(GetDataCollectionIDList) GetDataCollectionIDList

Anchor(MakeDataCollection) MakeDataCollection collectionType

Volume

A 3D volume for display in a 2DMRI layer.

Surface

A 3D surface for display in a 2DMRIS layer.

Anchor(DeleteDataCollection) DeleteDataCollection collectionID

Anchor(WritePathFile) WritePathFile fileName

Anchor(ReadPathFile) ReadPathFile fileName

Anchor(ClearSegVolReport) ClearSegVolReport

Anchor(SetSegVolReportSegmentation) SetSegVolReportSegmentation segID

Anchor(AddSegVolReportIntensityVolume) AddSegVolReportIntensityVolume volID

Anchor(SetROIForSegVolReport) SetROIForSegVolReport volID roiID

Anchor(DontUseROIInSegVolReport) DontUseROIInSegVolReport

Anchor(SetSegVolReportLUT) SetSegVolReportLUT lutID

Anchor(AddSegmentationToSegVolReport) AddSegmentationToSegVolReport structure

Anchor(MakeSegVolReport) MakeSegVolReport fnReport

Anchor(MakeSegVolIntensityReport) MakeSegVolIntensityReport fnReport

Anchor(SetToolMode) SetToolMode toolID mode

navigation

The navigation tool

plane

The plane tool

marker

The marker tool

voxelEditing

The voxel editing tool

voxelFilling

The voxel filling tool

roiEditing

The ROI editing tool

roiFilling

The ROI filling tool

straightPath

The straight path tool

edgePath

The edge path tool

Anchor(GetToolMode) GetToolMode toolID

Anchor(SetToolTargetLayer) SetToolTargetLayer toolID layerID

Anchor(GetToolTargetLayer) GetToolTargetLayer toolID

Anchor(SetToolNewVoxelValue) SetToolNewVoxelValue toolID value

Anchor(GetToolNewVoxelValue) GetToolNewVoxelValue toolID

Anchor(SetToolEraseVoxelValue) SetToolEraseVoxelValue toolID value

Anchor(GetToolEraseVoxelValue) GetToolEraseVoxelValue toolID

Anchor(SetToolOnlyBrushZero) SetToolOnlyBrushZero toolID onlyZero

Anchor(GetToolOnlyBrushZero) GetToolOnlyBrushZero toolID

Anchor(SetToolBrushRadius) SetToolBrushRadius toolID radius

Anchor(GetToolBrushRadius) GetToolBrushRadius toolID

Anchor(SetToolBrushShape) SetToolBrushShape toolID shape

Anchor(GetToolBrushShape) GetToolBrushShape toolID

Anchor(SetToolBrush3D) SetToolBrush3D toolID 3D

Anchor(GetToolBrush3D) GetToolBrush3D toolID

Anchor(SetToolFloodStopAtPaths) SetToolFloodStopAtPaths toolID stop

Anchor(GetToolFloodStopAtPaths) GetToolFloodStopAtPaths toolID

Anchor(SetToolFloodStopAtROIs) SetToolFloodStopAtROIs toolID stop

Anchor(GetToolFloodStopAtROIs) GetToolFloodStopAtROIs toolID

Anchor(SetToolFloodFuzziness) SetToolFloodFuzziness toolID fuzziness

Anchor(GetToolFloodFuzziness) GetToolFloodFuzziness toolID

Anchor(SetToolFloodMaxDistance) SetToolFloodMaxDistance toolID distance

Anchor(GetToolFloodMaxDistance) GetToolFloodMaxDistance toolID

Anchor(SetToolFlood3D) SetToolFlood3D toolID 3D

Anchor(GetToolFlood3D) GetToolFlood3D toolID

Anchor(SetToolFloodSourceCollection) SetToolFloodSourceCollection toolID collectionID

Anchor(SetToolFloodFuzzinessType) SetToolFloodFuzzinessType toolID type

Anchor(GetToolFloodFuzzinessType) GetToolFloodFuzzinessType toolID

Anchor(GetToolFloodSourceCollection) GetToolFloodSourceCollection toolID

Anchor(SetToolOnlyFloodZero) SetToolOnlyFloodZero toolID onlyZero

Anchor(GetToolOnlyFloodZero) GetToolOnlyFloodZero toolID

Anchor(SetToolEdgePathStraightBias) SetToolEdgePathStraightBias toolID bias

Anchor(GetToolEdgePathStraightBias) GetToolEdgePathStraightBias toolID

Anchor(SetToolEdgePathEdgeBias) SetToolEdgePathEdgeBias toolID bias

Anchor(GetToolEdgePathEdgeBias) GetToolEdgePathEdgeBias toolID

Anchor(SetFrameViewConfiguration) SetFrameViewConfiguration frameID configuration

Anchor(GetViewIDFromFrameColRow) GetViewIDFromFrameColRow frameID col row

Anchor(GetSelectedViewID) GetSelectedViewID frameID

Anchor(SetSelectedViewID) SetSelectedViewID frameID viewID

Anchor(GetNumberOfRowsInFrame) GetNumberOfRowsInFrame frameID

Anchor(GetNumberOfColsAtRowInFrame) GetNumberOfColsAtRowInFrame frameID row

Anchor(GetViewIDAtFrameLocation) GetViewIDAtFrameLocation frameID windowX windowY

Anchor(GetColumnOfViewInFrame) GetColumnOfViewInFrame frameID viewID

Anchor(GetRowOfViewInFrame) GetRowOfViewInFrame frameID viewID

Anchor(RedrawFrame) RedrawFrame frameID

Anchor(CopyViewLayersToAllViewsInFrame) CopyViewLayersToAllViewsInFrame frameID viewID

Anchor(GetToolIDForFrame) GetToolIDForFrame frameID

Anchor(CycleCurrentViewInFrame) CycleCurrentViewInFrame frameID

Anchor(CaptureFrameToFile) CaptureFrameToFile frameID fileName

Anchor(SetTransformLabel) SetTransformLabel transformID label

Anchor(GetTransformLabel) GetTransformLabel transformID

Anchor(SetTransformValues) SetTransformValues transformID listOfValues

Anchor(GetTransformValues) GetTransformValues transformID

Anchor(LoadTransformFromLTAFile) LoadTransformFromLTAFile transformID LTAFileName

Anchor(InvertTransform) InvertTransform transformID

Anchor(TreatTransformAsRegistration) TreatTransformAsRegistration transformID sourceVolumeID destVolumeID

Anchor(TreatTransformAsNative) TreatTransformAsNative transformID

Anchor(IsTransformRegistration) IsTransformRegistration transformID

Anchor(GetTransformRegistrationSource) GetTransformRegistrationSource transformID

Anchor(GetTransformRegistrationDest) GetTransformRegistrationDest transformID

Anchor(SetViewInPlane) SetViewInPlane viewID inPlane

Anchor(GetViewInPlane) GetViewInPlane viewID

Anchor(SetViewZoomLevel) SetViewZoomLevel viewID zoomLevel

Anchor(GetViewZoomLevel) GetViewZoomLevel viewID

Anchor(SetViewRASCenter) SetViewRASCenter viewID x y z

Anchor(GetViewRASCenter) GetViewRASCenter viewID

Anchor(SetLayerInViewAtLevel) SetLayerInViewAtLevel viewID layerID level

Anchor(GetLayerInViewAtLevel) GetLayerInViewAtLevel viewID level

Anchor(RemoveAllLayersFromView) RemoveAllLayersFromView viewID

Anchor(RemoveLayerFromViewAtLevel) RemoveLayerFromViewAtLevel viewID level

Anchor(SetLevelVisibilityInView) SetLevelVisibilityInView viewID level visibility

Anchor(GetLevelVisibilityInView) GetLevelVisibilityInView viewID level

Anchor(SetLevelReportInfoInView) SetLevelReportInfoInView viewID level reportInfo

Anchor(GetLevelReportInfoInView) GetLevelReportInfoInView viewID level

Anchor(SetViewStateToLayerBounds) SetViewStateToLayerBounds viewID layerID

Anchor(GetFirstUnusedDrawLevelInView) GetFirstUnusedDrawLevelInView viewID

Anchor(SetViewLinkedStatus) SetViewLinkedStatus viewID linked

Anchor(GetViewLinkedStatus) GetViewLinkedStatus viewID

Anchor(SetViewLockOnCursor) SetViewLockOnCursor viewID lock

Anchor(GetViewLockOnCursor) GetViewLockOnCursor viewID

Anchor(SetViewTransform) SetViewTransform viewID transformID

Anchor(GetViewTransform) GetViewTransform viewID

Anchor(SetViewFlipLeftRightYZ) SetViewFlipLeftRightYZ viewID flip

Anchor(GetViewFlipLeftRightYZ) GetViewFlipLeftRightYZ viewID

Anchor(SetViewThroughPlaneIncrement) SetViewThroughPlaneIncrement viewID throughPlane increment

Anchor(GetViewThroughPlaneIncrement) GetViewThroughPlaneIncrement viewID throughPlane

Anchor(GetVolumeHistogramInView) GetVolumeHistogramInView viewID volID roiID numBins

Anchor(BeginValueRangeFillInView) BeginValueRangeFillInView viewID sourceVolID roiID destVolID

Anchor(DoOneValueRangeFillInView) DoOneValueRangeFillInView viewID beginValueRange endValueRange fillValue

Anchor(EndValueRangeFillInView) EndValueRangeFillInView viewID

Anchor(ConvertWindowToViewRAS) ConvertWindowToViewRAS viewID windowX windowY

Anchor(SetColorLUTLabel) SetColorLUTLabel lutID label

Anchor(GetColorLUTLabel) GetColorLUTLabel lutID

Anchor(SetColorLUTFileName) SetColorLUTFileName lutID fileName

Anchor(GetColorLUTFileName) GetColorLUTFileName lutID

Anchor(GetColorLUTNumberOfEntries) GetColorLUTNumberOfEntries lutID

Anchor(GetColorLUTEntryLabel) GetColorLUTEntryLabel lutID entry

Anchor(GetColorLUTEntryRGB) GetColorLUTEntryRGB lutID entry

Anchor(IsColorLUTEntryValid) IsColorLUTEntryValid lutID entry

Anchor(GetSubjectName) GetSubjectName

Anchor(GetSubjectDir) GetSubjectDir

Anchor(NewVolume) NewVolume templateID createLayer frameIDToAdd

Anchor(LoadVolume) LoadVolume fileName createLayer frameIDToAdd

Anchor(LoadSurface) LoadSurface fileName createLayer frameIDToAdd

Anchor(LoadTransform) LoadTransform fileName

Anchor(SaveSceneScript) SaveSceneScript fileName

Anchor(GetMainFrameID) GetMainFrameID

Anchor(UpdateFrame) UpdateFrame frameID

Anchor(SetCursorFromSurfaceVertexIndex) SetCursorFromSurfaceVertexIndex layerID vertexNumber

Anchor(SetCursorFromEditDatFile) SetCursorFromEditDatFile

Anchor(WriteCursorToEditDatFile) WriteCursorToEditDatFile

Anchor(SetCursorFromVolumeIndexCoords) SetCursorFromVolumeIndexCoords collectionID x y z