Load a new image. More...

#include <RootLoadImage.hpp>

Inheritance diagram for FotoSHOCKcore::RootLoadImageDescriptor:

Public Member Functions
	RootLoadImageDescriptor (const std::string fileName)

	RootLoadImageDescriptor (PixelData format, const std::string fileName)

virtual const char *	name ()
	Name of the operation. More...

virtual const char *	description ()
	Description of the operation. More...

virtual ImageOperation *	operation ()
	Create a new ImageOperation object. More...

virtual ImageOperationType	operationType ()
	Return a type of the ImageOperation. More...

virtual InputProto	inputPrototype ()
	Description of inputs. More...

virtual OutputProto	outputPrototype ()
	Description of outputs. More...

Public Member Functions inherited from FotoSHOCKcore::ImageOperationDescriptor
	ImageOperationDescriptor ()
	Default constructor.

virtual	~ImageOperationDescriptor ()
	A destructor.

uint64_t	id ()
	Unique identifier of the operation descriptor. More...

Additional Inherited Members
Public Types inherited from FotoSHOCKcore::ImageOperationDescriptor
enum	ImageOperationType { TypeNone, TypeRoot, TypeNorm, TypePreview, TypeConvertFormat }
	Possible types of ImageOperation s. More...

Detailed Description

Load a new image.

Loads an image.

The format used is the same as the format of the input image.

Parameters

fileName path to the image

Member Function Documentation

virtual const char* FotoSHOCKcore::RootLoadImageDescriptor::description ( )

inlinevirtual

Description of the operation.

Returns: description of the operation

Implements FotoSHOCKcore::ImageOperationDescriptor.

virtual InputProto FotoSHOCKcore::RootLoadImageDescriptor::inputPrototype ( )

inlinevirtual

Description of inputs.

Describes inputs of the operation. This includes PixelData format, that is accepted by each input.

The default implementation returns prototype specifying one input, that accepts any kind of ValueType, with arbitrary bit depth and arbitrary color space.

Returns: description of inputs

Reimplemented from FotoSHOCKcore::ImageOperationDescriptor.

virtual const char* FotoSHOCKcore::RootLoadImageDescriptor::name ( )

inlinevirtual

Name of the operation.

The name of operation will be shown in a graph.

Returns: name of the operation

Implements FotoSHOCKcore::ImageOperationDescriptor.

ImageOperation * RootLoadImageDescriptor::operation ( )

virtual

Create a new ImageOperation object.

This function is used to obtain a new instance of the associated ImageOperation. The object must be allocated on heap using new. The memory is freed automatically when the object is not needed anymore.

Returns: new ImageOperation object

Implements FotoSHOCKcore::ImageOperationDescriptor.

virtual ImageOperationType FotoSHOCKcore::RootLoadImageDescriptor::operationType ( )

inlinevirtual

Return a type of the ImageOperation.

By default ImageOperationType::TypeNorm is returned. If the operation is one of the special operations the getImageOperationType() must be overloaded appropriately.

Returns: the type of the operation

Reimplemented from FotoSHOCKcore::ImageOperationDescriptor.

virtual OutputProto FotoSHOCKcore::RootLoadImageDescriptor::outputPrototype ( )

inlinevirtual

Description of outputs.

Describes outputs of the operation.This includes PixelData format, that is provided by each input.

The default implementation returns prototype specifying one output, that has the same format as the input.

NOTE: Currently only one output is supported

Returns: description of outputs

Reimplemented from FotoSHOCKcore::ImageOperationDescriptor.

The documentation for this class was generated from the following files:

/home/lukas/development/C++/FotoSHOCK/src/core/rootops/RootLoadImage.hpp
/home/lukas/development/C++/FotoSHOCK/src/core/rootops/RootLoadImage.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation