MyCaffe.param.OptionalParameter Class Reference

The OptionalParameter is the base class for parameters that are optional such as the MaskParameter, DistorationParameter, ExpansionParameter, NoiseParameter, and ResizeParameter. More...

Inheritance diagram for MyCaffe.param.OptionalParameter:

Public Member Functions
	OptionalParameter (bool bActive=false)
	The constructor. More...
virtual void	Copy (OptionalParameter src)
	Copy the source object. More...
virtual RawProto	ToProto (string strName)
	Convert this object to a raw proto. More...

Static Public Member Functions
static OptionalParameter	FromProto (RawProto rp)
	Parses the parameter from a RawProto. More...

Properties
bool	Active [getset]
	When active, the parameter is used, otherwise it is ignored. More...

Detailed Description

The OptionalParameter is the base class for parameters that are optional such as the MaskParameter, DistorationParameter, ExpansionParameter, NoiseParameter, and ResizeParameter.

Definition at line 16 of file OptionalParameter.cs.

Constructor & Destructor Documentation

OptionalParameter()

MyCaffe.param.OptionalParameter.OptionalParameter

(

bool

bActive = false

)

The constructor.

Parameters

bActive

Specifies whether or not the parameter is active (default = false).

Definition at line 24 of file OptionalParameter.cs.

Member Function Documentation

Copy()

virtual void MyCaffe.param.OptionalParameter.Copy ( OptionalParameter  src )

virtual

Copy the source object.

Parameters

src	Specifies the source data.

Reimplemented in MyCaffe.param.ssd.DistortionParameter, MyCaffe.param.ssd.EmitConstraint, MyCaffe.param.ssd.ExpansionParameter, MyCaffe.param.ssd.NoiseParameter, MyCaffe.param.ssd.NonMaximumSuppressionParameter, MyCaffe.param.ssd.ResizeParameter, MyCaffe.param.ssd.SaltPepperParameter, MyCaffe.param.ssd.SaveOutputParameter, MyCaffe.param.DataLabelMappingParameter, and MyCaffe.param.MaskParameter.

Definition at line 43 of file OptionalParameter.cs.

FromProto()

static OptionalParameter MyCaffe.param.OptionalParameter.FromProto ( RawProto  rp )

static

Parses the parameter from a RawProto.

Parameters

rp	Specifies the RawProto to parse.

Returns

A new instance of the parameter is returned.

Definition at line 67 of file OptionalParameter.cs.

ToProto()

virtual RawProto MyCaffe.param.OptionalParameter.ToProto ( string  strName )

virtual

Convert this object to a raw proto.

Parameters

strName

Specifies the name of the proto.

Returns

The new proto is returned.

Reimplemented in MyCaffe.param.ssd.DistortionParameter, MyCaffe.param.ssd.EmitConstraint, MyCaffe.param.ssd.ExpansionParameter, MyCaffe.param.ssd.NoiseParameter, MyCaffe.param.ssd.NonMaximumSuppressionParameter, MyCaffe.param.ssd.ResizeParameter, MyCaffe.param.ssd.SaltPepperParameter, MyCaffe.param.ssd.SaveOutputParameter, MyCaffe.param.DataLabelMappingParameter, and MyCaffe.param.MaskParameter.

Definition at line 53 of file OptionalParameter.cs.

Property Documentation

Active

bool MyCaffe.param.OptionalParameter.Active

getset

When active, the parameter is used, otherwise it is ignored.

Definition at line 33 of file OptionalParameter.cs.

---

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

• C:/Data/Data/SS_Projects/Intelligence/GitHub/MyCaffe/MyCaffe/param/OptionalParameter.cs