NAME

OME::Tasks::PixelsManager

Back to Top

SYNOPSIS

Back to Top

DESCRIPTION

Provides methods to accomplish common Pixel tasks.

Back to Top

METHODS

createOriginalFileAttribute

        my $originalFilesAttribute = OME::Tasks::PixelsManager->
      createOriginalFileAttribute($omeis_file_object, $format, $file_mex, $full_path );
    
Create an original file attribute. $full_path is optional. omeis stores the 
file name, and strips the path of the imported file. This mechanism allows 
the original path to be stored in the OriginalFile's Path element for 
subsequent queries. If $full_path is not specified, OriginalFile's Path 
element will default to the file name.

loadOriginalFile

getPixelType

Usage

        my $pixelType = OME::Tasks::PixelsManager->getPixelType(
                $bytesPerPixel,$isSigned,$isFloat);

retrieves the name of a Pixel type from a description.

getPixelTypeInfo

createPixels

Usage: my ($pixels_data, $pixels_attr) = OME::Tasks::PixelsManager-> createPixels($image,$module_execution, { SizeX => $sizeX, SizeY => $sizeY, SizeZ => $sizeZ, SizeC => $sizeC, SizeT => $sizeT, PixelType => $pixelType } );

Creates Object representations of the pixels data (see OME::Image::Pixels) and the pixels attribute (see OME::SemanticTypes::Superclass and Pixels Semantic Type Definition).

OME::Tasks::PixelsManager->finishPixels($pixels_data, $pixels_attr) will need to be called after the data has been written.

finishPixels

Usage: my $pixelsID = OME::Tasks::PixelsManager->finishPixels($pixels_data, $pixels_attr);

Finalizes the pixels data, sets the FileSHA1 of the pixels attribute, and sets the thumbnail.

loadPixels

        # load the pixels data object (see OME::Image::Pixels for interface)
        my $pixels_data = OME::Tasks::PixelsManager->loadPixels( $pixels_attr );

saveThumb

        # set the image thumbnail to the provided DisplayOptions attribute
        OME::Tasks::PixelsManager->saveThumb( $pixels_attr, $displayOptions );

getThumbURL

        # retrieve the URL for the thumbnail of the specified pixels attribute
        my $thumbnailURL = OME::Tasks::PixelsManager->getThumbURL($pixels);

        # retrieve the URL for the thumbnail of the specified pixels id
        my $thumbnailURL = OME::Tasks::PixelsManager->getThumbURL($pixelsID);

getDisplayOptions

This will load a displayOptions or make default if none exist

_makeDefaultDisplayOptions

This will make default display options, but will not commit the transaction

Back to Top

AUTHOR

Douglas Creager <dcreager@alum.mit.edu>, Open Microscopy Environment, MIT

Back to Top

SEE ALSO

OME, http://www.openmicroscopy.org/

Back to Top