ViewingOptions struct
Model that determines the dip::viewer::SliceViewer’s behavior
Contents
Constructors, destructors, assignment and conversion operators
- ViewingOptions(dip::Image const& image) explicit
- Calculate default options from an image
Enums
- enum class ComplexToReal: uint8
- Complex-to-real mapping options more...
- enum class Diff: uint8
- Defines which view (parts) need to be recalculated more...
- enum class LookupTable: uint8
- Grey-value to color mapping options more...
- enum class Mapping: uint8
- Grey-value mapping options more...
- enum class Projection: uint8
- Slice projection options more...
Functions
- auto diff(dip::viewer::ViewingOptions const& options) const -> dip::viewer::ViewingOptions::Diff
- Calculates which view (parts) need to be recalculated
- auto getComplexDescription() const -> dip::String
- Returns a textual description of the current complex-to-real mapping
- auto getLookupTableDescription() const -> dip::String
- Returns a textual description of the current grey-value to color mapping
- auto getMappingDescription() const -> dip::String
- Returns a textual description of the current grey-value mapping
- auto getProjectionDescription() const -> dip::String
- Returns a textual description of the current slice projection
- auto needsReproject(dip::viewer::ViewingOptions const& options, dip::uint dimx, dip::uint dimy) const -> bool
- Calculates whether a particular slice projection needs to be recalculated
- void setAutomaticRange()
- Sets automatic range based on current lookup table and mapping
- void setMappingRange(dip::viewer::ViewingOptions::Mapping mapping)
- Sets mapping range based on mapping
Variables
- dip::IntegerArray color_elements_
- Which tensor element is R, G, and B.
- dip::viewer::ViewingOptions::ComplexToReal complex_
- What to do with complex numbers.
- dip::IntegerArray dims_
- Dimensions to visualize (MainX, MainY, LeftX, TopY). Use -1 to not map to any image dimension.
- dip::uint element_
- Tensor element to visualize.
- dip::String labels_
- Labels to use for axes, one character per axis.
- dip::viewer::ViewingOptions::LookupTable lut_
- Grey-value to color mapping options.
- dip::viewer::ViewingOptions::Mapping mapping_
- Grey-value mapping options, sets mapping_range_.
- dip::viewer::FloatRange mapping_range_
- mapped value range (colorbar limits).
- dip::PhysicalQuantityArray offset_
- Offset of origin pixel in real-world coordinates.
- dip::UnsignedArray operating_point_
- Coordinates of selected point, which also determines which slice is shown.
- dip::FloatArray origin_
- Display origin for moving the image around.
- dip::viewer::ViewingOptions::Projection projection_
- Type of projection.
- dip::viewer::FloatRange range_
- value range across image (histogram limits).
- dip::UnsignedArray roi_origin_
- Origin of projection ROI.
- dip::UnsignedArray roi_sizes_
- Sizes of projection ROI.
- dip::IntegerArray split_
- Split point between projections (pixels).
- dip::String status_
- Status bar text.
- dip::viewer::FloatRangeArray tensor_range_
- value range per tensor.
- dip::FloatArray zoom_
- Zoom factor per dimension (from physical dimensions + user). Also determines relative viewport sizes.
Enum documentation
enum class ComplexToReal: uint8
Complex-to-real mapping options
enum class Mapping: uint8
Grey-value mapping options
enum class Projection: uint8
Slice projection options
enum class LookupTable: uint8
Grey-value to color mapping options
enum class Diff: uint8
Defines which view (parts) need to be recalculated
Function documentation
ViewingOptions( dip::Image const& image) explicit
Calculate default options from an image
dip::viewer::ViewingOptions::Diff diff( dip::viewer::ViewingOptions const& options) const
Calculates which view (parts) need to be recalculated
bool needsReproject( dip::viewer::ViewingOptions const& options, dip::uint dimx, dip::uint dimy) const
Calculates whether a particular slice projection needs to be recalculated
void setAutomaticRange( )
Sets automatic range based on current lookup table and mapping
void setMappingRange( dip::viewer::ViewingOptions::Mapping mapping)
Sets mapping range based on mapping
dip::String getComplexDescription( ) const
Returns a textual description of the current complex-to-real mapping
dip::String getMappingDescription( ) const
Returns a textual description of the current grey-value mapping
dip::String getProjectionDescription( ) const
Returns a textual description of the current slice projection
dip::String getLookupTableDescription( ) const
Returns a textual description of the current grey-value to color mapping
Variable documentation
dip::IntegerArray dims_
Dimensions to visualize (MainX, MainY, LeftX, TopY). Use -1 to not map to any image dimension.
dip::UnsignedArray operating_point_
Coordinates of selected point, which also determines which slice is shown.
dip::viewer::ViewingOptions::ComplexToReal complex_
What to do with complex numbers.
dip::viewer::ViewingOptions::Projection projection_
Type of projection.
dip::UnsignedArray roi_origin_
Origin of projection ROI.
dip::UnsignedArray roi_sizes_
Sizes of projection ROI.
dip::String labels_
Labels to use for axes, one character per axis.
dip::viewer::FloatRange range_
value range across image (histogram limits).
dip::viewer::FloatRangeArray tensor_range_
value range per tensor.
dip::viewer::FloatRange mapping_range_
mapped value range (colorbar limits).
dip::viewer::ViewingOptions::Mapping mapping_
Grey-value mapping options, sets mapping_range_.
dip::viewer::ViewingOptions::LookupTable lut_
Grey-value to color mapping options.
dip::IntegerArray color_elements_
Which tensor element is R, G, and B.
dip::IntegerArray split_
Split point between projections (pixels).
dip::FloatArray zoom_
Zoom factor per dimension (from physical dimensions + user). Also determines relative viewport sizes.
dip::FloatArray origin_
Display origin for moving the image around.
dip::PhysicalQuantityArray offset_
Offset of origin pixel in real-world coordinates.
dip::String status_
Status bar text.