DIPviewer module
#include "diplib/viewer/viewer.h"

dip::viewer::ViewingOptions struct

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

static auto ComplexToRealAsString(dip::viewer::ViewingOptions::ComplexToReal value) -> dip::String

Translate an enum for the complex-to-real mapping options to a string

static auto ComplexToRealDescription(dip::viewer::ViewingOptions::ComplexToReal value) -> dip::String

Translate an enum for the complex-to-real mapping options to a longer description string

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

static auto LookupTableAsString(dip::viewer::ViewingOptions::LookupTable value) -> dip::String

Translate an enum for the grey-value to color mapping options to a string

static auto LookupTableDescription(dip::viewer::ViewingOptions::LookupTable value) -> dip::String

Translate an enum for the grey-value to color mapping options to a longer description string

static auto MappingAsString(dip::viewer::ViewingOptions::Mapping value) -> dip::String

Translate an enum for the grey-value mapping options to a string

static auto MappingDescription(dip::viewer::ViewingOptions::Mapping value) -> dip::String

Translate an enum for the grey-value mapping options to a longer description string

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

static auto ProjectionAsString(dip::viewer::ViewingOptions::Projection value) -> dip::String

Translate an enum for the slice projection options to a string

static auto ProjectionDescription(dip::viewer::ViewingOptions::Projection value) -> dip::String

Translate an enum for the slice projection options to a longer description string

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. Turns on automatic mapping.

static auto TranslateComplexToRealString(dip::String const& string) -> dip::viewer::ViewingOptions::ComplexToReal

Translate a string to an enum for the complex-to-real mapping options

static auto TranslateLookupTableString(dip::String const& string) -> dip::viewer::ViewingOptions::LookupTable

Translate a string to an enum for the grey-value to color mapping options

static auto TranslateMappingString(dip::String const& string) -> dip::viewer::ViewingOptions::Mapping

Translate a string to an enum for the grey-value mapping options

static auto TranslateProjectionString(dip::String const& string) -> dip::viewer::ViewingOptions::Projection

Translate a string to an enum for the slice projection options

Variables

bool auto_mapping_

Automatically adapt mapping_range_ to histogram limits when image changes.

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

Function documentation

Variable documentation