Version: 5.3.3-ice35-b63

OmeroBlitz API
Home Previous Up Next Index

omero::api::IProjection

Overview

[ "ami", "amd" ] interface IProjection extends ServiceInterface

Provides methods for performing projections of Pixels sets.

Operation Index

projectStack
Performs a projection through the optical sections of a particular wavelength at a given time point of a Pixels set.
projectPixels
Performs a projection through selected optical sections and optical sections for a given set of time points of a Pixels set.

Operations

::Ice::ByteSeq projectStack(long pixelsId, model::PixelsType pixelsType, constants::projection::ProjectionType algorithm, int timepoint, int channelIndex, int stepping, int start, int end) throws ServerError

Performs a projection through the optical sections of a particular wavelength at a given time point of a Pixels set.

Parameters

pixelsId
The source Pixels set Id.
pixelsType
The destination Pixels type. If null, the source Pixels set pixels type will be used.
algorithm
MAXIMUM_INTENSITY, MEAN_INTENSITY or SUM_INTENSITY. NOTE: When performing a SUM_INTENSITY projection, pixel values will be pinned to the maximum pixel value of the destination Pixels type.
timepoint
Timepoint to perform the projection.
channelIndex
Index of the channel to perform the projection.
stepping
Stepping value to use while calculating the projection. For example, 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.
start
Optical section to start projecting from.
end
Optical section to finish projecting.

Return Value

A byte array of projected pixel values whose length is equal to the Pixels set 8 sizeX * sizeY * bytesPerPixel in big-endian format.

Exceptions

ValidationException
Where:

See Also

projectPixels

long projectPixels(long pixelsId, model::PixelsType pixelsType, constants::projection::ProjectionType algorithm, int tStart, int tEnd, sys::IntList channelList, int stepping, int zStart, int zEnd, string name) throws ServerError

Performs a projection through selected optical sections and optical sections for a given set of time points of a Pixels set. The Image which is linked to the Pixels set will be copied using IPixels::copyAndResizeImage.

Parameters

pixelsId
The source Pixels set Id.
pixelsType
The destination Pixels type. If null, the source Pixels set pixels type will be used.
algorithm
MAXIMUM_INTENSITY, MEAN_INTENSITY or SUM_INTENSITY. NOTE: When performing a SUM_INTENSITY projection, pixel values will be pinned to the maximum pixel value of the destination Pixels type.
tStart
Timepoint to start projecting from.
tEnd
Timepoint to finish projecting.
channels
List of the channel indexes to use while calculating the projection.
stepping
Stepping value to use while calculating the projection. For example, 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.
zStart
Optical section to start projecting from.
zEnd
Optical section to finish projecting.
name
Name for the newly created image. If null the name of the Image linked to the Pixels qualified by pixelsId will be used with a Projection suffix. For example, GFP-H2B Image of HeLa Cells will have an Image name of GFP-H2B Image of HeLa Cells Projection used for the projection.

Return Value

The Id of the newly created Image which has been projected.

Exceptions

ValidationException
Where:

See Also

projectStack

Home Previous Up Next Index