MyCaffe  1.12.2.41
Deep learning software for Windows C# programmers.
MyCaffe.param.ssd.BatchSampler Class Reference

Specifies a sample of batch of bboxes with provided constraints in SSD. More...

Inheritance diagram for MyCaffe.param.ssd.BatchSampler:
MyCaffe.basecode.BaseParameter MyCaffe.basecode.IBinaryPersist

Public Member Functions

 BatchSampler ()
 The BatchSampler constructor. More...
 
void Save (BinaryWriter bw)
 Save the BatchSampler to a binary writer. More...
 
object Load (BinaryReader br, bool bNewInstance)
 Load the BatchSampler from a binary reader. More...
 
BatchSampler Clone ()
 Creates a copy of the BatchSampler. More...
 
bool Compare (BatchSampler bs)
 Compares this BatchSampler to another. More...
 
int CompareTo (object obj)
 Compares this BatchSampler to another. More...
 
override RawProto ToProto (string strName)
 Converts the BatchSampler to a RawProto. More...
 
override string ToString ()
 Return the string representation of the shape. More...
 
- Public Member Functions inherited from MyCaffe.basecode.BaseParameter
 BaseParameter ()
 Constructor for the parameter. More...
 
virtual bool Compare (BaseParameter p)
 Compare this parameter to another parameter. More...
 

Static Public Member Functions

static BatchSampler Load (BinaryReader br)
 Load the BatchSampler from a binary reader. More...
 
static BatchSampler FromProto (RawProto rp)
 Parse a new BatchSampler from a RawProto. More...
 
- Static Public Member Functions inherited from MyCaffe.basecode.BaseParameter
static double ParseDouble (string strVal)
 Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 
static bool TryParse (string strVal, out double df)
 Parse double values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 
static float ParseFloat (string strVal)
 Parse float values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 
static bool TryParse (string strVal, out float f)
 Parse doufloatble values using the US culture if the decimal separator = '.', then using the native culture, and if then lastly trying the US culture to handle prototypes containing '.' as the separator, yet parsed in a culture that does not use '.' as a decimal. More...
 

Properties

bool use_original_image [getset]
 Use the original image as the source for sampling. More...
 
uint max_sample [getset]
 If provided (greater than zero), break when found certain number of samples satisfying the sample constraint. More...
 
uint max_trials [getset]
 Maximum number of trials for sampling to avoid an infinite loop. More...
 
Sampler sampler [getset]
 Specifies the constraints for sampling the bbox More...
 
SamplerConstraint sample_constraint [getset]
 Get/set the sample constraint. More...
 

Detailed Description

Specifies a sample of batch of bboxes with provided constraints in SSD.

See also
SSD: Single Shot MultiBox Detector by Wei Liu, Dragomir Anguelov, Dumitru Erhan, Christian Szegedy, Scott Reed, Cheng-Yang Fu, Alexander C. Berg, 2016.
GitHub: SSD: Single Shot MultiBox Detector, by weiliu89/caffe, 2016

Definition at line 21 of file BatchSampler.cs.

Constructor & Destructor Documentation

◆ BatchSampler()

MyCaffe.param.ssd.BatchSampler.BatchSampler ( )

The BatchSampler constructor.

Definition at line 32 of file BatchSampler.cs.

Member Function Documentation

◆ Clone()

BatchSampler MyCaffe.param.ssd.BatchSampler.Clone ( )

Creates a copy of the BatchSampler.

Returns
A new instance of the BatchSampler is returned.

Definition at line 131 of file BatchSampler.cs.

◆ Compare()

bool MyCaffe.param.ssd.BatchSampler.Compare ( BatchSampler  bs)

Compares this BatchSampler to another.

Parameters
bsSpecifies the other BatchSampler to compare this one to.
Returns
If the two BatchSampler's are the same true is returned, otherwise false is returned.

Definition at line 158 of file BatchSampler.cs.

◆ CompareTo()

int MyCaffe.param.ssd.BatchSampler.CompareTo ( object  obj)

Compares this BatchSampler to another.

Parameters
objSpecifies the other BatchSampler to compare this one to.
Returns
If the two BatchSampler's are the same true is returned, otherwise false is returned.

Definition at line 183 of file BatchSampler.cs.

◆ FromProto()

static BatchSampler MyCaffe.param.ssd.BatchSampler.FromProto ( RawProto  rp)
static

Parse a new BatchSampler from a RawProto.

Parameters
rpSpecifies the RawProto containing a representation of the BatchSampler.
Returns
A new instance of the BatchSampler is returned.

Definition at line 220 of file BatchSampler.cs.

◆ Load() [1/2]

static BatchSampler MyCaffe.param.ssd.BatchSampler.Load ( BinaryReader  br)
static

Load the BatchSampler from a binary reader.

Parameters
brThe binary reader to use.
Returns
A new BatchSampler instance is returned.

Definition at line 76 of file BatchSampler.cs.

◆ Load() [2/2]

object MyCaffe.param.ssd.BatchSampler.Load ( BinaryReader  br,
bool  bNewInstance 
)

Load the BatchSampler from a binary reader.

Parameters
brThe binary reader to use.
bNewInstanceWhen true, a the BatchSampler is read into a new instance, otherwise it is read into the current instance.
Returns
The BatchSampler instance is returned.

Implements MyCaffe.basecode.IBinaryPersist.

Definition at line 55 of file BatchSampler.cs.

◆ Save()

void MyCaffe.param.ssd.BatchSampler.Save ( BinaryWriter  bw)

Save the BatchSampler to a binary writer.

Parameters
bwThe binary writer to use.

Implements MyCaffe.basecode.IBinaryPersist.

Definition at line 40 of file BatchSampler.cs.

◆ ToProto()

override RawProto MyCaffe.param.ssd.BatchSampler.ToProto ( string  strName)
virtual

Converts the BatchSampler to a RawProto.

Parameters
strNameSpecifies a name for the RawProto.
Returns
A new RawProto representing the BatchSampler is returned.

Implements MyCaffe.basecode.BaseParameter.

Definition at line 201 of file BatchSampler.cs.

◆ ToString()

override string MyCaffe.param.ssd.BatchSampler.ToString ( )

Return the string representation of the shape.

Returns
The string representation is returned.

Definition at line 249 of file BatchSampler.cs.

Property Documentation

◆ max_sample

uint MyCaffe.param.ssd.BatchSampler.max_sample
getset

If provided (greater than zero), break when found certain number of samples satisfying the sample constraint.

Definition at line 94 of file BatchSampler.cs.

◆ max_trials

uint MyCaffe.param.ssd.BatchSampler.max_trials
getset

Maximum number of trials for sampling to avoid an infinite loop.

Definition at line 103 of file BatchSampler.cs.

◆ sample_constraint

SamplerConstraint MyCaffe.param.ssd.BatchSampler.sample_constraint
getset

Get/set the sample constraint.

Definition at line 121 of file BatchSampler.cs.

◆ sampler

Sampler MyCaffe.param.ssd.BatchSampler.sampler
getset

Specifies the constraints for sampling the bbox

Definition at line 112 of file BatchSampler.cs.

◆ use_original_image

bool MyCaffe.param.ssd.BatchSampler.use_original_image
getset

Use the original image as the source for sampling.

Definition at line 85 of file BatchSampler.cs.


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