Synapseml  1.0.2
Public Member Functions | Static Public Member Functions | List of all members
Synapse.ML.Onnx.ImageFeaturizer Class Reference

ImageFeaturizer implements ImageFeaturizer More...

Inheritance diagram for Synapse.ML.Onnx.ImageFeaturizer:
Inheritance graph
[legend]
Collaboration diagram for Synapse.ML.Onnx.ImageFeaturizer:
Collaboration graph
[legend]

Public Member Functions

 ImageFeaturizer ()
 Creates a ImageFeaturizer without any parameters. More...
 
 ImageFeaturizer (string uid)
 Creates a ImageFeaturizer with a UID that is used to give the ImageFeaturizer a unique ID. More...
 
ImageFeaturizer SetAutoConvertToColor (bool value)
 Sets value for autoConvertToColor More...
 
ImageFeaturizer SetChannelNormalizationMeans (double[] value)
 Sets value for channelNormalizationMeans More...
 
ImageFeaturizer SetChannelNormalizationStds (double[] value)
 Sets value for channelNormalizationStds More...
 
ImageFeaturizer SetColorScaleFactor (double value)
 Sets value for colorScaleFactor More...
 
ImageFeaturizer SetDropNa (bool value)
 Sets value for dropNa More...
 
ImageFeaturizer SetFeatureTensorName (string value)
 Sets value for featureTensorName More...
 
ImageFeaturizer SetHeadless (bool value)
 Sets value for headless More...
 
ImageFeaturizer SetIgnoreDecodingErrors (bool value)
 Sets value for ignoreDecodingErrors More...
 
ImageFeaturizer SetImageHeight (int value)
 Sets value for imageHeight More...
 
ImageFeaturizer SetImageTensorName (string value)
 Sets value for imageTensorName More...
 
ImageFeaturizer SetImageWidth (int value)
 Sets value for imageWidth More...
 
ImageFeaturizer SetInputCol (string value)
 Sets value for inputCol More...
 
ImageFeaturizer SetOnnxModel (JavaTransformer value)
 Sets value for onnxModel More...
 
ImageFeaturizer SetOutputCol (string value)
 Sets value for outputCol More...
 
ImageFeaturizer SetOutputTensorName (string value)
 Sets value for outputTensorName More...
 
bool GetAutoConvertToColor ()
 Gets autoConvertToColor value More...
 
double[] GetChannelNormalizationMeans ()
 Gets channelNormalizationMeans value More...
 
double[] GetChannelNormalizationStds ()
 Gets channelNormalizationStds value More...
 
double GetColorScaleFactor ()
 Gets colorScaleFactor value More...
 
bool GetDropNa ()
 Gets dropNa value More...
 
string GetFeatureTensorName ()
 Gets featureTensorName value More...
 
bool GetHeadless ()
 Gets headless value More...
 
bool GetIgnoreDecodingErrors ()
 Gets ignoreDecodingErrors value More...
 
int GetImageHeight ()
 Gets imageHeight value More...
 
string GetImageTensorName ()
 Gets imageTensorName value More...
 
int GetImageWidth ()
 Gets imageWidth value More...
 
string GetInputCol ()
 Gets inputCol value More...
 
JavaTransformer GetOnnxModel ()
 Gets onnxModel value More...
 
string GetOutputCol ()
 Gets outputCol value More...
 
string GetOutputTensorName ()
 Gets outputTensorName 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< ImageFeaturizerRead ()
 Get the corresponding JavaMLReader instance. More...
 

Static Public Member Functions

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

Detailed Description

ImageFeaturizer implements ImageFeaturizer

Constructor & Destructor Documentation

◆ ImageFeaturizer() [1/2]

Synapse.ML.Onnx.ImageFeaturizer.ImageFeaturizer ( )
inline

Creates a ImageFeaturizer without any parameters.

◆ ImageFeaturizer() [2/2]

Synapse.ML.Onnx.ImageFeaturizer.ImageFeaturizer ( string  uid)
inline

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

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

Member Function Documentation

◆ GetAutoConvertToColor()

bool Synapse.ML.Onnx.ImageFeaturizer.GetAutoConvertToColor ( )

Gets autoConvertToColor value

Returns
autoConvertToColor: Whether to automatically convert black and white images to color. default = true

◆ GetChannelNormalizationMeans()

double [] Synapse.ML.Onnx.ImageFeaturizer.GetChannelNormalizationMeans ( )

Gets channelNormalizationMeans value

Returns
channelNormalizationMeans: Normalization means for color channels

◆ GetChannelNormalizationStds()

double [] Synapse.ML.Onnx.ImageFeaturizer.GetChannelNormalizationStds ( )

Gets channelNormalizationStds value

Returns
channelNormalizationStds: Normalization std's for color channels

◆ GetColorScaleFactor()

double Synapse.ML.Onnx.ImageFeaturizer.GetColorScaleFactor ( )

Gets colorScaleFactor value

Returns
colorScaleFactor: Color scale factor

◆ GetDropNa()

bool Synapse.ML.Onnx.ImageFeaturizer.GetDropNa ( )

Gets dropNa value

Returns
dropNa: Whether to drop na values before mapping

◆ GetFeatureTensorName()

string Synapse.ML.Onnx.ImageFeaturizer.GetFeatureTensorName ( )

Gets featureTensorName value

Returns
featureTensorName: the name of the tensor to include in the fetch dict

◆ GetHeadless()

bool Synapse.ML.Onnx.ImageFeaturizer.GetHeadless ( )

Gets headless value

Returns
headless: whether to use the feature tensor or the output tensor

◆ GetIgnoreDecodingErrors()

bool Synapse.ML.Onnx.ImageFeaturizer.GetIgnoreDecodingErrors ( )

Gets ignoreDecodingErrors value

Returns
ignoreDecodingErrors: Whether to throw on decoding errors or just return None

◆ GetImageHeight()

int Synapse.ML.Onnx.ImageFeaturizer.GetImageHeight ( )

Gets imageHeight value

Returns
imageHeight: Size required by model

◆ GetImageTensorName()

string Synapse.ML.Onnx.ImageFeaturizer.GetImageTensorName ( )

Gets imageTensorName value

Returns
imageTensorName: the name of the tensor to include in the fetch dict

◆ GetImageWidth()

int Synapse.ML.Onnx.ImageFeaturizer.GetImageWidth ( )

Gets imageWidth value

Returns
imageWidth: Size required by model

◆ GetInputCol()

string Synapse.ML.Onnx.ImageFeaturizer.GetInputCol ( )

Gets inputCol value

Returns
inputCol: The name of the input column

◆ GetOnnxModel()

JavaTransformer Synapse.ML.Onnx.ImageFeaturizer.GetOnnxModel ( )
inline

Gets onnxModel value

Returns
onnxModel: The internal ONNX model used in the featurizer

◆ GetOutputCol()

string Synapse.ML.Onnx.ImageFeaturizer.GetOutputCol ( )

Gets outputCol value

Returns
outputCol: The name of the output column

◆ GetOutputTensorName()

string Synapse.ML.Onnx.ImageFeaturizer.GetOutputTensorName ( )

Gets outputTensorName value

Returns
outputTensorName: the name of the tensor to include in the fetch dict

◆ Load()

static ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.Load ( string  path)
static

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

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

◆ Read()

JavaMLReader<ImageFeaturizer> Synapse.ML.Onnx.ImageFeaturizer.Read ( )

Get the corresponding JavaMLReader instance.

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

◆ Save()

void Synapse.ML.Onnx.ImageFeaturizer.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

◆ SetAutoConvertToColor()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetAutoConvertToColor ( bool  value)

Sets value for autoConvertToColor

Parameters
valueWhether to automatically convert black and white images to color. default = true
Returns
New ImageFeaturizer object

◆ SetChannelNormalizationMeans()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetChannelNormalizationMeans ( double[]  value)

Sets value for channelNormalizationMeans

Parameters
valueNormalization means for color channels
Returns
New ImageFeaturizer object

◆ SetChannelNormalizationStds()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetChannelNormalizationStds ( double[]  value)

Sets value for channelNormalizationStds

Parameters
valueNormalization std's for color channels
Returns
New ImageFeaturizer object

◆ SetColorScaleFactor()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetColorScaleFactor ( double  value)

Sets value for colorScaleFactor

Parameters
valueColor scale factor
Returns
New ImageFeaturizer object

◆ SetDropNa()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetDropNa ( bool  value)

Sets value for dropNa

Parameters
valueWhether to drop na values before mapping
Returns
New ImageFeaturizer object

◆ SetFeatureTensorName()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetFeatureTensorName ( string  value)

Sets value for featureTensorName

Parameters
valuethe name of the tensor to include in the fetch dict
Returns
New ImageFeaturizer object

◆ SetHeadless()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetHeadless ( bool  value)

Sets value for headless

Parameters
valuewhether to use the feature tensor or the output tensor
Returns
New ImageFeaturizer object

◆ SetIgnoreDecodingErrors()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetIgnoreDecodingErrors ( bool  value)

Sets value for ignoreDecodingErrors

Parameters
valueWhether to throw on decoding errors or just return None
Returns
New ImageFeaturizer object

◆ SetImageHeight()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetImageHeight ( int  value)

Sets value for imageHeight

Parameters
valueSize required by model
Returns
New ImageFeaturizer object

◆ SetImageTensorName()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetImageTensorName ( string  value)

Sets value for imageTensorName

Parameters
valuethe name of the tensor to include in the fetch dict
Returns
New ImageFeaturizer object

◆ SetImageWidth()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetImageWidth ( int  value)

Sets value for imageWidth

Parameters
valueSize required by model
Returns
New ImageFeaturizer object

◆ SetInputCol()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetInputCol ( string  value)

Sets value for inputCol

Parameters
valueThe name of the input column
Returns
New ImageFeaturizer object

◆ SetOnnxModel()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetOnnxModel ( JavaTransformer  value)

Sets value for onnxModel

Parameters
valueThe internal ONNX model used in the featurizer
Returns
New ImageFeaturizer object

◆ SetOutputCol()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetOutputCol ( string  value)

Sets value for outputCol

Parameters
valueThe name of the output column
Returns
New ImageFeaturizer object

◆ SetOutputTensorName()

ImageFeaturizer Synapse.ML.Onnx.ImageFeaturizer.SetOutputTensorName ( string  value)

Sets value for outputTensorName

Parameters
valuethe name of the tensor to include in the fetch dict
Returns
New ImageFeaturizer object

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