qa.qcri.prepocressor.datastructures

Class Individual

java.lang.Object

qa.qcri.prepocressor.datastructures.Individual

public class Individual
extends java.lang.Object

An individual represents an entity that can be passed through the pipeline. The entity is usually associated with a file name and an OpenCV Mat file.

Author:

Felix Stahlberg

See Also:

Population

Constructor Summary

Constructors

Constructor and Description
Individual() Builds an individual instance without content.
Individual(java.lang.String idxPrefix) Builds an individual instance without content.

Method Summary

Methods

Modifier and Type	Method and Description
org.opencv.core.Mat	getContent()
java.lang.String	getIdxPrefix()
Individual	getParent()
org.opencv.core.Rect	getParentRect()
Population	getPopulation()
java.lang.String	getTargetFileName(java.lang.String path) Get the full target file name.
boolean	hasParent()
boolean	loadContent(java.lang.String fileName) Load the content of this individual from a file.
boolean	loadCsv(java.lang.String fileName) Load the content from a CSV file.
Individual	produceChild(org.opencv.core.Rect roi) Produce a child from a submatrix of the content.
Individual	produceChild(org.opencv.core.Rect roi, boolean setContent) Produce a child from a submatrix of the content.
void	setContent(org.opencv.core.Mat content) Set individual content.
void	setIdxPrefix(java.lang.String idxPrefix)
void	setParent(Individual parent, org.opencv.core.Rect parentRect) Set a new parent.
void	setPopulation(Population pop) Set the population this individual belongs to.
boolean	store(java.lang.String path) Write the content of this individual into a file.
boolean	storeCsv(java.lang.String fileName) Store the content as csv file (only the first channel).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Individual

public Individual()

Builds an individual instance without content.

Individual

public Individual(java.lang.String idxPrefix)

Builds an individual instance without content.

Parameters:

idxPrefix - prefix to be prepend when substituting %idx

Method Detail

setPopulation

public void setPopulation(Population pop)

Set the population this individual belongs to.

Parameters:

pop - new population instance

hasParent

public boolean hasParent()

Returns:

true iff parent is not null

getParent

public Individual getParent()

Returns:

parent individual or null if this individual has no parent

getParentRect

public org.opencv.core.Rect getParentRect()

Returns:

region of the parent individual in which this individual is placed or null if this individual has no parent

setParent

public void setParent(Individual parent,
             org.opencv.core.Rect parentRect)

Set a new parent.

Parameters:

parent - parent individual

parentRect - region of the children within the parent

getPopulation

public Population getPopulation()

Returns:

population this individual belongs to

loadContent

public boolean loadContent(java.lang.String fileName)

Load the content of this individual from a file. The file name is passed through to OpenCV's imread function. If this function fails, we try to parse it as csv file. If this fails, we return false.

Parameters:

fileName - path to the file

Returns:

true if the content was loaded successfully, false otherwise

getIdxPrefix

public java.lang.String getIdxPrefix()

Returns:

the index prefix. The index prefix is a string that is inserted when %idx is substituted

getContent

public org.opencv.core.Mat getContent()

Returns:

the content of this individual which is an OpenCV Mat (image)

setIdxPrefix

public void setIdxPrefix(java.lang.String idxPrefix)

Parameters:

idxPrefix - the index prefix to set. The index prefix is a string that is inserted when %idx is substituted

store

public boolean store(java.lang.String path)

Write the content of this individual into a file.

Parameters:

path - Path with placeholders to the target files. See the -outputPath parameter

Returns:

true if the file was written successfully, false otherwise

Throws:

java.lang.NullPointerException - if fileNamePattern is null or the content of this individual is null or if the population was not set

See Also:

setPopulation(Population)

getTargetFileName

public java.lang.String getTargetFileName(java.lang.String path)

Get the full target file name.

Parameters:

path - Path with placeholders to the target files. See the -outputPath parameter

Returns:

target file name

storeCsv

public boolean storeCsv(java.lang.String fileName)

Store the content as csv file (only the first channel).

Parameters:

fileName - path to the file to write (without placeholders)

Returns:

false if an error occurred, true otherwise

Throws:

java.lang.NullPointerException - if fileName or content is null

loadCsv

public boolean loadCsv(java.lang.String fileName)

Load the content from a CSV file. The length of the first row defines the number of columns. If consecutive lines contain a different number of elements, output a warning and fill up with zeros / cut.

Parameters:

fileName - path to the CSV file (without placeholders)

Returns:

true if the content was loaded successfully, false otherwise

setContent

public void setContent(org.opencv.core.Mat content)

Set individual content.

Parameters:

content - new content

produceChild

public Individual produceChild(org.opencv.core.Rect roi)

Produce a child from a submatrix of the content.

Parameters:

roi - region in content of this child

Returns:

child individual instance

Throws:

java.lang.NullPointerException - if content or roi is null

produceChild

public Individual produceChild(org.opencv.core.Rect roi,
                      boolean setContent)

Produce a child from a submatrix of the content.

Parameters:

roi - region in content of this child

setContent - set child content to submatrix

Returns:

child individual instance

Throws:

java.lang.NullPointerException - if content or roi is null