Synapseml  0.10.0
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Opencv.ImageTransformer Class Reference

ImageTransformer implements ImageTransformer More...

Inheritance diagram for Synapse.ML.Opencv.ImageTransformer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Opencv.ImageTransformer:
Collaboration graph
[legend]

Public Member Functions

 ImageTransformer ()
 Creates a ImageTransformer without any parameters. More...
 
 ImageTransformer (string uid)
 Creates a ImageTransformer with a UID that is used to give the ImageTransformer a unique ID. More...
 
ImageTransformer SetColorScaleFactor (double value)
 Sets value for colorScaleFactor More...
 
ImageTransformer SetInputCol (string value)
 Sets value for inputCol More...
 
ImageTransformer SetNormalizeMean (double[] value)
 Sets value for normalizeMean More...
 
ImageTransformer SetNormalizeStd (double[] value)
 Sets value for normalizeStd More...
 
ImageTransformer SetOutputCol (string value)
 Sets value for outputCol More...
 
ImageTransformer SetStages (Dictionary< string, object >[] value)
 Sets value for stages More...
 
ImageTransformer SetTensorChannelOrder (string value)
 Sets value for tensorChannelOrder More...
 
ImageTransformer SetTensorElementType (DataType value)
 Sets value for tensorElementType More...
 
ImageTransformer SetToTensor (bool value)
 Sets value for toTensor More...
 
double GetColorScaleFactor ()
 Gets colorScaleFactor value More...
 
string GetInputCol ()
 Gets inputCol value More...
 
double [] GetNormalizeMean ()
 Gets normalizeMean value More...
 
double [] GetNormalizeStd ()
 Gets normalizeStd value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
Dictionary< string, object > [] GetStages ()
 Gets stages value More...
 
string GetTensorChannelOrder ()
 Gets tensorChannelOrder value More...
 
DataType GetTensorElementType ()
 Gets tensorElementType value More...
 
bool GetToTensor ()
 Gets toTensor value More...
 
void Save (string path)
 Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala. More...
 
JavaMLWriter Write ()
 
Returns
a JavaMLWriter instance for this ML instance.

 
JavaMLReader< ImageTransformerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

static ImageTransformer Load (string path)
 Loads the ImageTransformer that was previously saved using Save(string). More...
 

Detailed Description

ImageTransformer implements ImageTransformer

Constructor & Destructor Documentation

◆ ImageTransformer() [1/2]

Synapse.ML.Opencv.ImageTransformer.ImageTransformer ( )
inline

Creates a ImageTransformer without any parameters.

◆ ImageTransformer() [2/2]

Synapse.ML.Opencv.ImageTransformer.ImageTransformer ( string  uid)
inline

Creates a ImageTransformer with a UID that is used to give the ImageTransformer a unique ID.

Parameters
uidAn immutable unique ID for the object and its derivatives.

Member Function Documentation

◆ GetColorScaleFactor()

double Synapse.ML.Opencv.ImageTransformer.GetColorScaleFactor ( )

Gets colorScaleFactor value

Returns
colorScaleFactor: The scale factor for color values. Used for normalization. The color values will be multiplied with the scale factor.

◆ GetInputCol()

string Synapse.ML.Opencv.ImageTransformer.GetInputCol ( )

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetNormalizeMean()

double [] Synapse.ML.Opencv.ImageTransformer.GetNormalizeMean ( )

Gets normalizeMean value

Returns
normalizeMean: The mean value to use for normalization for each channel. The length of the array must match the number of channels of the input image.

◆ GetNormalizeStd()

double [] Synapse.ML.Opencv.ImageTransformer.GetNormalizeStd ( )

Gets normalizeStd value

Returns
normalizeStd: The standard deviation to use for normalization for each channel. The length of the array must match the number of channels of the input image.

◆ GetOutputCol()

string Synapse.ML.Opencv.ImageTransformer.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetStages()

Dictionary<string, object> [] Synapse.ML.Opencv.ImageTransformer.GetStages ( )
inline

Gets stages value

Returns
stages: Image transformation stages

◆ GetTensorChannelOrder()

string Synapse.ML.Opencv.ImageTransformer.GetTensorChannelOrder ( )

Gets tensorChannelOrder value

Returns
tensorChannelOrder: The color channel order of the output channels. Valid values are RGB and GBR. Default: RGB.

◆ GetTensorElementType()

DataType Synapse.ML.Opencv.ImageTransformer.GetTensorElementType ( )
inline

Gets tensorElementType value

Returns
tensorElementType: The element data type for the output tensor. Only used when toTensor is set to true. Valid values are DoubleType or FloatType. Default value: FloatType.

◆ GetToTensor()

bool Synapse.ML.Opencv.ImageTransformer.GetToTensor ( )

Gets toTensor value

Returns
toTensor: Convert output image to tensor in the shape of (C * H * W)

◆ Load()

static ImageTransformer Synapse.ML.Opencv.ImageTransformer.Load ( string  path)
static

Loads the ImageTransformer that was previously saved using Save(string).

Parameters
pathThe path the previous ImageTransformer was saved to
Returns
New ImageTransformer object, loaded from path.

◆ Read()

JavaMLReader<ImageTransformer> Synapse.ML.Opencv.ImageTransformer.Read ( )

Get the corresponding JavaMLReader instance.

Returns
an JavaMLReader<ImageTransformer> instance for this ML instance.

◆ Save()

void Synapse.ML.Opencv.ImageTransformer.Save ( string  path)

Saves the object so that it can be loaded later using Load. Note that these objects can be shared with Scala by Loading or Saving in Scala.

Parameters
pathThe path to save the object to

◆ SetColorScaleFactor()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetColorScaleFactor ( double  value)

Sets value for colorScaleFactor

Parameters
valueThe scale factor for color values. Used for normalization. The color values will be multiplied with the scale factor.
Returns
New ImageTransformer object

◆ SetInputCol()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetInputCol ( string  value)

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New ImageTransformer object

◆ SetNormalizeMean()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetNormalizeMean ( double []  value)

Sets value for normalizeMean

Parameters
valueThe mean value to use for normalization for each channel. The length of the array must match the number of channels of the input image.
Returns
New ImageTransformer object

◆ SetNormalizeStd()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetNormalizeStd ( double []  value)

Sets value for normalizeStd

Parameters
valueThe standard deviation to use for normalization for each channel. The length of the array must match the number of channels of the input image.
Returns
New ImageTransformer object

◆ SetOutputCol()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ImageTransformer object

◆ SetStages()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetStages ( Dictionary< string, object > []  value)

Sets value for stages

Parameters
valueImage transformation stages
Returns
New ImageTransformer object

◆ SetTensorChannelOrder()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetTensorChannelOrder ( string  value)

Sets value for tensorChannelOrder

Parameters
valueThe color channel order of the output channels. Valid values are RGB and GBR. Default: RGB.
Returns
New ImageTransformer object

◆ SetTensorElementType()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetTensorElementType ( DataType  value)

Sets value for tensorElementType

Parameters
valueThe element data type for the output tensor. Only used when toTensor is set to true. Valid values are DoubleType or FloatType. Default value: FloatType.
Returns
New ImageTransformer object

◆ SetToTensor()

ImageTransformer Synapse.ML.Opencv.ImageTransformer.SetToTensor ( bool  value)

Sets value for toTensor

Parameters
valueConvert output image to tensor in the shape of (C * H * W)
Returns
New ImageTransformer object

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