represents a contour segmentation object.
|
Public Member Functions |
| | CSO () |
| | Standard constructor. The unique id is initialized with 0.
|
| | CSO (CSOList *csoList) |
| | Constructor takes a pointer to the CSOList this CSO is in; in this method, the unique id is set.
|
| | CSO (const CSO &cso, CSOList *csoList=NULL) |
| | Copy constructor; the unique id is initialized with 0.
|
| virtual | ~CSO () |
| | Standard destructor.
|
| void | reverseSeedPointOrder () |
| | Reverses the order of all seed points and clears all path points in between.
|
| void | resortSeedPointsClockwise () |
| void | saveAttributes (std::ostream &outStream) |
| | Save attributes to stream.
|
| void | loadAttributes (std::istream &inStream, short version, bool swapBytes) |
| | Load attributes from stream.
|
|
| void | applyTransformationMatrix (const Matrix4 &matrix) |
| | Applies the given 4x4 matrix on all path and seed points.
|
| void | moveSeedPointsAndPathPoints (float dx, float dy, float dz, int timepoint) |
| | Moves all seed points and all path points by the given coordinates offset and timepoint.
|
| void | setAbsoluteMovement (float fromX, float fromY, float fromZ, float toX, float toY, float toZ, int fromTimePointIndex, int toTimePointIndex) |
| | Sets the absolute movement for undo/redo.
|
| void | moveSingleSeedPoint (CSOSeedPoint *sPoint, float dx, float dy, float dz) |
| | Moves a certain seed point by the given coordinate offset.
|
| void | setAbsoluteSeedPointMovement () |
| | Sets the absolute movement of a single seed point for undo/redo.
|
|
| CSOSeedPoint * | appendSeedAndPathPoint () |
| | Appends a seed point and a path point list to the end of the seed point list and returns a pointer to it.
|
| CSOSeedPoint * | appendSeedAndPathPoint (const Vector3 &position) |
| | Appends a seed point and a path point list to the end of the seed point list and returns a pointer to it.
|
| CSOPathPoints * | insertPathPointsEndStart () |
| | Inserts a CSOPathPoint between the ending and the starting seed points and returns a pointer to it.
|
| CSOSeedPoint * | appendSeedPoint () |
| | Appends just a seed point to the internal list and returns a pointer to it.
|
| CSOPathPoints * | appendPathPoints () |
| | Appends just a path point list the internal list and returns a pointer to it.
|
| void | removeSeedPoint (CSOSeedPoint *sPoint) |
| | Removes the given seed point from this CSO.
|
| void | removeAllSeedAndPathPoints () |
| | Removes all seed points and all path point lists from this CSO.
|
| CSOSeedPoint * | insertSeedPointAt (CSOPathPoints *toBeSplitPath, const Vector3 &toInsertPos) |
| | Inserts a seed point into the given toBeSplitPath at the given position.
|
| void | setInsertRemoveSeedPoint () |
| | Triggers the according undo/redo command to be put on the stack.
|
|
| CSOSeedPoint * | getSeedPointAt (unsigned int index) const |
| | Returns a pointer to the seed point at the given index.
|
| CSOSeedPoint * | getFirstSeedPoint () const |
| | Returns a pointer to the first seed point of this CSO.
|
| CSOSeedPoint * | getLastSeedPoint () const |
| | Returns a pointer to the last seed point of this CSO.
|
| unsigned int | numSeedPoints () const |
| | Returns the number of seed points.
|
| bool | getSeedPointIndex (CSOSeedPoint *sPoint, unsigned int &index) const |
| | Sets the sIndex to the index of the given seed point and returns true, if such a seed point exists.
|
| unsigned int | numPathPointLists () const |
| | Returns the number of path point lists.
|
| void | fillPathPointCoordinatesFlattened (std::vector< Vector3 > &pathPointCoords) const |
| | Fills up the given std::vector<Vector3> with all the path point coordinates in order.
|
| void | fillPathPointCoordinatesFlattened (std::vector< Vector4 > &pathPointCoordsAndValues) const |
| | Fills up the given std::vector<Vector4> with all the path point coordinates and values in order.
|
| CSOPathPoints * | getPathPointsAt (unsigned int index) const |
| | Returns the list of path points at a given position.
|
| unsigned int | getTotalNumPathPoints () const |
| | Returns the total number of path points in this CSO; this number may differ from the number of path points obtained by a flattened positions vector.
|
| unsigned int | getTotalNumUniquePathPoints () const |
| | Returns the total number of unique path points in this CSO; this number equals the number of path points obtained by a flattened positions vector.
|
|
| void | addSelectedSeedPoint (CSOSeedPoint *sPoint) |
| | Adds the given seed point to the list of selected seed points.
|
| void | setSelectedSeedPoint (CSOSeedPoint *sPoint) |
| | Sets the given seed point as being selected, and deselects all previously selected seed points.
|
| bool | isSelectedSeedPoint (CSOSeedPoint *sPoint) const |
| | Returns if the given seed point is selected.
|
| void | clearSelectedSeedPoints () |
| | Clears the list of selected seed points.
|
| unsigned int | getNumSelectedSeedPoints () const |
| | Returns the number of selected seed points.
|
| CSOSeedPoint * | getSelectedSeedPointAt (unsigned int index) const |
| | Returns a pointer to a selected seed point at the given index.
|
|
| void | addGroup (CSOGroup *group) |
| | Adds a group to this CSO.
|
| void | addGroup (unsigned int groupId) |
| | Adds a group to this CSO by its Id.
|
| bool | isInGroup (CSOGroup *group) const |
| | Returns if this CSO is in the given Group.
|
| bool | isInGroup (unsigned int groupId) const |
| | Returns if this CSO is in the group with the given ID.
|
| unsigned int | numGroups () const |
| | Returns the number of groups this CSO is in.
|
| CSOGroup * | getGroupAt (unsigned int index) const |
| | Returns the group at the specified index. If the index is out of bounds, NULL is returned.
|
| unsigned int | getGroupIdAt (unsigned int index) const |
| | Returns a group id at the specified index.
|
| void | removeGroup (CSOGroup *group) |
| | Removes the given group from the internal list.
|
| void | removeAllGroups () |
| | Removes all groups from this CSO.
|
|
| void | setType (const std::string &type) |
| | Sets the type of the CSO. This is set by the Processor, which generates this CSO.
|
| const std::string & | getType () const |
| | Returns the type of the CSO. This is set by the Processor, which generated this CSO.
|
| void | setSubType (const std::string &subtype) |
| | Sets the subtype of the CSO. This is set by the Processor, which generates this CSO.
|
| const std::string & | getSubType () const |
| | Returns the type of the CSO. This is set by the Processor, which generated this CSO.
|
| void | setCreatorId (int id) |
| | Sets the creator ID of the CSO. This is set by the Processor, which generates this CSO.
|
| int | getCreatorId () const |
| | Returns the creator ID of the CSO. This is set by the Processor, which generated this CSO.
|
|
| const CSOBoundingBox & | getWorldBoundingBox () const |
| | Returns the bounding box of this contour in world coordinates.
|
| const CSOBoundingBox & | getVoxelBoundingBox (const Matrix4 &worldToVoxelMatrix) const |
| | Returns the bounding box of this contour in voxel coordinates computed by the given (image) matrix.
|
| const CSOBoundingBox & | getVoxelBoundingBoxSeedPoints (const Matrix4 &worldToVoxelMatrix) const |
| | Returns the bounding box of the seed points of this CSO in voxel coordinates computed by the given (image) matrix.
|
| void | setWorldToVoxelMatrix (const Matrix4 &mat) |
| | Sets the internal matrix to the world-to-voxel matrix of the image this CSO was generated on.
|
| const Matrix4 & | getWorldToVoxelMatrix () const |
| | Returns the world-to-voxel matrix of the image this CSO was generated on.
|
| bool | isInPlane () |
| | Returns the plane status (do all seed points lie in a plane?). If the method returns 'true', the plane normal is also valid.
|
| bool | isInPlane (Vector3 &planeNormal) |
| | Returns the plane status and fills the argument vector with the plane normal (only valid if all seed points lie in a plane).
|
| const Vector3 & | getPlaneNormal () const |
| | Returns the plane normal. Only valid, if isInPlane returns 'true'.
|
| void | computePlaneNormal () |
| | Forces to recompute the plane normal (status).
|
| void | setIsInPlane (bool status) |
| | Sets the plane normal status for this CSO.
|
| void | setPlaneNormal (const Vector3 &planeNormal) |
| | Sets the plane normal which becomes valid by this.
|
| void | invalidatePlaneNormal () |
| | Invalidates the plane normal.
|
| float | getLength () const |
| | Returns the length of this CSO (this is sum of the the euclidean distances between all successive path points).
|
| double | getArea () const |
| | Returns the area of this CSO (this value is only meaningful if all points lie in a plane).
|
| void | invalidateArea () |
| | Invalidates the internal area flag, so it can be recomputed.
|
| void | setIsClosed (bool isClosed) |
| | Sets the closed state of this contour.
|
| bool | isClosed () const |
| | Returns the closed state of this contour.
|
| void | setIsFinished (bool isFinished) |
| | Sets the finished status of this contour. Note that the finished status is set to 'true' if the contour is set to isClosed = true.
|
| bool | getIsFinished () const |
| | Returns the finished status of this contour.
|
| void | setNeedsInterpolation (bool needsInterpolation) |
| | Sets if this CSO needs interpolation.
|
| bool | getNeedsInterpolation () const |
| | Returns if this CSO needs interpolation.
|
| void | determineNeedsInterpolation () |
| | Determines by investigating the CSO's seed points if this CSO needs interpolation and sets this state to the CSO's internal variable.
|
| void | setNeedInterpolationAllSeedPoints (bool needsInterpolation) |
| | Sets the need for interpolation to all member seed points.
|
| void | setNeedInterpolation (CSOSeedPoint *seedPoint) |
| | Sets the need of being interpolated to the given seed point and to the CSO's state.
|
| void | pathChanged () |
| | Sets any pre-computed values depending on the exact path to invalid.
|
|
| void | setCSOList (CSOList *csoList) |
| | Sets the internal pointer to the embracing CSOList.
|
| CSOList * | getCSOList () const |
| | Returns the internal pointer to the embracing CSOList.
|
| unsigned int | getId () const |
| | Returns the unique ID of this CSO.
|
|
| void | setLabel (const std::string &label) |
| | Sets the label of this CSO.
|
| const std::string & | getLabel () const |
| | Returns the label of this CSO.
|
| void | setDescription (std::string description) |
| | Sets the description of this CSO.
|
| const std::string & | getDescription () const |
| | Returns the description of this CSO.
|
| void | setTimePointIndex (int index) |
| | Sets the time point index of this CSO.
|
| int | getTimePointIndex () const |
| | Returns the time point index of this CSO.
|
| void | setShowState (bool state) |
| | Sets the 'show' status of this CSO.
|
| bool | getShowState () const |
| | Returns the 'show' status of this CSO.
|
| void | setVoxelizeState (bool state) |
| | Sets the 'voxelize' state of this CSO.
|
| bool | getVoxelizeState () const |
| | Returns the 'voxelize' state of this CSO.
|
| void | setEditableState (bool state) |
| | Sets the 'editable' state of this CSO.
|
| bool | getEditableState () const |
| | Returns the 'editable' state of this CSO.
|
| void | setPathPointStyle (CSOLineStyle style) |
| | Sets the style of the path points.
|
| void | setPathPointStyle (int style) |
| | Sets the style of the path points as an int.
|
| CSOLineStyle | getPathPointStyle () const |
| | Returns the style of the path points.
|
| void | setPathPointWidth (float width) |
| | Sets the width of the path points.
|
| float | getPathPointWidth () const |
| | Returns the width of the path points.
|
| void | setPathPointColor (const Vector3 &color) |
| | Sets the color of the path points.
|
| Vector3 | getPathPointColor () const |
| | Returns the color of the path points.
|
| void | setPathPointAlpha (float alpha) |
| | Sets the alpha value of the path points.
|
| float | getPathPointAlpha () const |
| | Returns the alpha value of the path points.
|
| void | setSeedPointStyle (int style) |
| | Sets the style of the seed points.
|
| int | getSeedPointStyle () const |
| | Returns the style of the seed points.
|
| void | setSeedPointSize (float size) |
| | Sets the size of the seed points.
|
| float | getSeedPointSize () const |
| | Returns the size of the seed points.
|
| void | setSeedPointColor (const Vector3 &color) |
| | Sets the color of the seed points.
|
| Vector3 | getSeedPointColor () const |
| | Returns the color of the seed points.
|
| void | setSeedPointAlpha (float alpha) |
| | Sets the alpha value of the seed points.
|
| float | getSeedPointAlpha () const |
| | Returns the alpha value of the seed points.
|
| void | setVoxelWriteMode (int mode) |
| | Sets the voxel write mode of this CSO.
|
| int | getVoxelWriteMode () const |
| | Returns the voxel write mode of this CSO.
|
| void | setVoxelWriteValue (float value) |
| | Sets the voxel write value of this CSO.
|
| float | getVoxelWriteValue () const |
| | Returns the voxel write value of this CSO.
|
| void | setAllValuesTo (float value) |
| | Sets all position values to the given value.
|
|
| int | getPrivateTimePointIndex () const |
| | Returns the private attribute 'timePointIndex'.
|
| bool | getPrivateShowState () const |
| | Returns the private attribute 'showState'.
|
| bool | getPrivateVoxelizeState () const |
| | Returns the private attribute 'voxelizeState'.
|
| bool | getPrivateEditableState () const |
| | Returns the private attribute 'editableState'.
|
| int | getPrivatePathPointStyle () const |
| | Returns the private attribute 'path point style'.
|
| float | getPrivatePathPointWidth () const |
| | Returns the private attribute 'path point width'.
|
| Vector3 | getPrivatePathPointColor () const |
| | Returns the private attribute 'path point color'.
|
| float | getPrivatePathPointAlpha () const |
| | Returns the private attribute 'path point alpha'.
|
| int | getPrivateSeedPointStyle () const |
| | Returns the private attribute 'seed point style'.
|
| float | getPrivateSeedPointSize () const |
| | Returns the private attribute 'seed point size'.
|
| Vector3 | getPrivateSeedPointColor () const |
| | Returns the private attribute 'seed point color'.
|
| float | getPrivateSeedPointAlpha () const |
| | Returns the private attribute 'seed point alpha'.
|
| int | getPrivateVoxelWriteMode () const |
| | Returns the private attribute 'voxelWriteMode'.
|
| float | getPrivateVoxelWriteValue () const |
| | Returns the private attribute 'voxelWriteValue'.
|
| void | setPrivateIsFinished (bool isFinished) |
| | Sets the 'isFinished' flag without any side effects.
|
| void | setPrivateIsClosed (bool isClosedP) |
| | Sets the 'isClosed' flag without any side effects.
|
| void | setPrivateIsInPlane (bool isInPlaneP) |
| | Sets the 'isInPlane' flag without any side effects.
|
| void | setPrivateBoundingBox (const CSOBoundingBox &bb) |
| | Sets the bounding box of this CSO.
|
| void | setPrivatePlaneNormal (const Vector3 &normal) |
| | Sets the plane normal of this CSO.
|
| void | setId (unsigned int newId) |
| | Sets the unique ID of this CSO. Beware: do not set this ID programmatically unless you really know what you are doing!
|
|
| void | moveSeedPoints (float dx, float dy, float dz, int timepoint) |
| | /deprecated Use moveSeedPointsAndPathPoints() instead.
|
| void | setLineStyle (CSOLineStyle style) |
| | /deprecated Use setPathPointStyle() instead.
|
| CSOLineStyle | getLineStyle () const |
| | /deprecated Use getPathPointStyle() instead.
|
| void | setColor (const Vector3 &color) |
| | /deprecated Use setPathPointColor() instead.
|
| Vector3 | getColor () const |
| | /deprecated Use getPathPointColor() instead.
|
| void | setAlpha (float alpha) |
| | /deprecated Use setPathPointAlpha() instead.
|
| float | getAlpha () const |
| | /deprecated Use getPathPointAlpha() instead.
|
| void | setLineWidth (float width) |
| | /deprecated Use setPathPointWidth() instead.
|
| float | getLineWidth () const |
| | /deprecated Use getPathPointWidth() instead.
|
| void | setMarkerMode (int mode) |
| | /deprecated Use setSeedPointStyle() instead.
|
| int | getMarkerMode () const |
| | /deprecated Use getSeedPointStyle() instead.
|
| void | setMarkerColor (const Vector3 &color) |
| | /deprecated Use setSeedPointColor() instead.
|
| Vector3 | getMarkerColor () const |
| | /deprecated Use getSeedPointColor() instead.
|
| void | setMarkerAlpha (float alpha) |
| | /deprecated Use setSeedPointAlpha() instead.
|
| float | getMarkerAlpha () const |
| | /deprecated Use getSeedPointAlpha() instead.
|
| void | setMarkerSize (float size) |
| | /deprecated Use setSeedPointSize() instead.
|
| float | getMarkerSize () const |
| | /deprecated Use getSeedPointSize() instead.
|
| CSOLineStyle | getPrivateLineStyle () const |
| | /deprecated Use getPrivatePathPointStyle() instead.
|
| Vector3 | getPrivateColor () const |
| | /deprecated Use getPrivatePathPointColor() instead.
|
| float | getPrivateAlpha () const |
| | /deprecated Use getPrivatePathPointAlpha() instead.
|
| float | getPrivateLineWidth () const |
| | /deprecated Use getPrivatePathPointWidth() instead.
|
| int | getPrivateMarkerMode () const |
| | /deprecated Use getPrivateSeedPointStyle() instead.
|
| Vector3 | getPrivateMarkerColor () const |
| | /deprecated Use getPrivateSeedPointColor() instead.
|
| float | getPrivateMarkerAlpha () const |
| | /deprecated Use getPrivateSeedPointAlpha() instead.
|
| float | getPrivateMarkerSize () const |
| | /deprecated Use getPrivateSeedPointSize() instead.
|
represents a contour segmentation object.
It consists of a number of seed points and a number of path point lists whose points connect the seed points. The CSO has also a pointer to its embracing CSOList, and can be in a number of CSOGroups.
