Version: 5.3.3-ice35-b63
OmeroBlitz API
Version: 5.3.3-ice35-b63
|
Defines a service to render a given pixels set. A pixels set is a 5D array that stores the pixels data of an image, that is the pixels intensity values. Every instance of this service is paired up to a pixels set. Use this service to transform planes within the pixels set onto an RGB image. The RenderingEngine allows to fine-tune the settings that define the transformation context — that is, a specification of how raw pixels data is to be transformed into an image that can be displayed on screen. Those settings are referred to as rendering settings or display options. After tuning those settings it is possible to save them to the metadata repository so that they can be used the next time the pixels set is accessed for rendering; for example by another RenderingEngine instance. Note that the display options are specific to the given pixels set and are experimenter scoped — that is, two different users can specify different display options for the same pixels set. (A RenderingEngine instance takes this into account automatically as it is always bound to a given experimenter.) This service is thread-safe.
def according to
the current rendering settings.def according to
the current rendering settings.def according to
the current rendering settings and compresses the resulting
RGBA composite image.Deprecated.
true if the noise reduction algorithm
used to map the pixels intensity values is turned on,
false if the algorithm is turned off.true, unmaps the
channel otherwise.true if the channel is mapped,
false otherwise.Deprecated.
Deprecated.
Deprecated.
true if the pixels type is signed,
false otherwise.
Renders the data selected by def according to
the current rendering settings.
The passed argument selects a plane orthogonal to one
of the X, Y, or Z axes. How many
wavelengths are rendered and what color model is used
depends on the current rendering settings.
An RGB image ready to be displayed on screen.
def is null.
Renders the data selected by def according to
the current rendering settings.
The passed argument selects a plane orthogonal to one
of the X, Y, or Z axes. How many
wavelengths are rendered and what color model is used
depends on the current rendering settings.
An RGB image ready to be displayed on screen.
def is null.Performs a projection through selected optical sections of a particular timepoint with the currently active channels and renders the data for display.
stepping=1 will
use every optical section from
start to end
where stepping=2 will use every
other section from start to
end to perform the projection.A packed-integer RGBA rendered image of the projected pixels.
algorithm is unknowntimepoint is out of rangestart is out of rangeend is out of rangestart > end
Renders the data selected by def according to
the current rendering settings and compresses the resulting
RGBA composite image.
A compressed RGBA JPEG for display.
def is null.Performs a projection through selected optical sections of a particular timepoint with the currently active channels, renders the data for display and compresses the resulting RGBA composite image.
stepping=1 will
use every optical section from
start to end
where stepping=2 will use every
other section from start to
end to perform the projection.A compressed RGBA rendered JPEG image of the projected pixels.
algorithm is unknowntimepoint is out of rangestart is out of rangeend is out of rangestart > endReturns the id of the model::RenderingDef loaded by either lookupRenderingDef or loadRenderingDef.
Loads the Pixels set this Rendering Engine is for.
Loads the rendering settings associated to the specified pixels set.
true if a RenderingDef exists for the
Pixels set, otherwise false.
Loads a specific set of rendering settings that does not necessarily have to be linked to the given Pixels set. However, the rendering settings must be linked to a compatible Pixels set as defined by IRenderingSettings::sanityCheckPixels.
renderingDefId or if
the RenderingDef is incompatible due to differing
pixels sets.Informs the rendering engine that it should render a set of overlays on each rendered frame. These are expected to be binary masks.
This operation is deprecated.
Creates an instance of the rendering engine.
Specifies the model that dictates how transformed raw data has to be mapped onto a color space.
Returns the model that dictates how transformed raw data has to be mapped onto a color space.
Returns the index of the default focal section.
Returns the default timepoint index.
Sets the index of the default focal section. This index is used to define a default plane.
Sets the default timepoint index. This index is used to define a default plane.
Returns the model::Pixels set the Rendering engine is for.
Returns the list of color models supported by the Rendering engine.
Returns the list of mapping families supported by the Rendering engine.
Sets the quantization strategy. The strategy is common to all channels.
Sets the sub-interval of the device space i.e. a discrete sub-interval of [0, 255].
Returns the quantization object.
Sets the quantization map, one per channel.
true to turn the
noise reduction algorithm on,
false otherwise.Returns the family associated to the specified channel.
See above.
Returns true if the noise reduction algorithm
used to map the pixels intensity values is turned on,
false if the algorithm is turned off. Each
channel has an algorithm associated to it.
See above.
Returns the coefficient identifying a map in the family. Each channel has a map associated to it.
See above.
Returns the pixels intensity interval. Each channel has a pixels intensity interval associated to it.
Returns the lower bound of the pixels intensity interval. Each channel has a pixels intensity interval associated to it.
Returns the upper bound of the pixels intensity interval. Each channel has a pixels intensity interval associated to it.
Sets the four components composing the color associated to the specified channel.
Returns a 4D-array representing the color associated to the specified channel. The first element corresponds to the red component (value between 0 and 255). The second corresponds to the green component (value between 0 and 255). The third corresponds to the blue component (value between 0 and 255). The fourth corresponds to the alpha component (value between 0 and 255).
Maps the specified channel if true, unmaps the
channel otherwise.
true to map the channel,
false otherwise.
Returns true if the channel is mapped,
false otherwise.
Adds the context to the mapping chain. Only one context of the same type can be added to the chain. The codomain transformations are functions from the device space to device space. Each time a new context is added, the second LUT is rebuilt.
This operation is deprecated.
Updates the specified context. The codomain chain already contains the specified context. Each time a new context is updated, the second LUT is rebuilt.
This operation is deprecated.
Removes the specified context from the chain. Each time a new context is removed, the second LUT is rebuilt.
This operation is deprecated.
Adds the context to the mapping chain. Only one context of the same type can be added to the chain. The codomain transformations are functions from the device space to device space. Each time a new context is added, the second LUT is rebuilt.
Removes the specified context from the chain. Each time a new context is removed, the second LUT is rebuilt.
Saves the current rendering settings in the database.
Saves the current rendering settings in the database as a new model::RenderingDef and loads the object into the current RenderingEngine.
Resets the default settings i.e. the default values internal to the Rendering engine. The settings will be saved.
true to save the settings,
false otherwise.Sets the current compression level for the service. (The default is 85%)
percentage
Returns the current compression level for the service.
Returns true if the pixels type is signed,
false otherwise.
Returns the minimum value for that channels depending on the pixels type and the original range (globalmax, globalmin)
Returns the maximum value for that channels depending on the pixels type and the original range (globalmax, globalmin)
Returns the list of codomain contexts for the specified channel.
|