Inheritance diagram for ProgAddNoise:

Collaboration diagram for ProgAddNoise:

Protected Member Functions
void	defineParams ()

void	readParams ()

void	show ()

template<typename T >
void	limit (Image< T > &img)

void	processImage (const FileName &fnImg, const FileName &fnImgOut, const MDRow &rowIn, MDRow &rowOut)

Protected Member Functions inherited from XmippMetadataProgram
virtual void	initComments ()

virtual void	preProcess ()

virtual void	postProcess ()

virtual bool	getImageToProcess (size_t &objId, size_t &objIndex)

void	show () const override

virtual void	startProcessing ()

virtual void	finishProcessing ()

virtual void	writeOutput ()

virtual void	showProgress ()

virtual void	defineLabelParam ()

Protected Member Functions inherited from XmippProgram
void	defineCommons ()

Protected Attributes
double	param1

double	param2

double	df

double	limit0

double	limitF

bool	do_limit0

bool	do_limitF

std::string	noise_type

Protected Attributes inherited from XmippMetadataProgram
WriteModeMetaData	mode
	Metadata writing mode: OVERWRITE, APPEND. More...

FileName	oext
	Output extension and root. More...

FileName	oroot

MDLabel	image_label
	MDLabel to be used to read/write images, usually will be MDL_IMAGE. More...

bool	produces_an_output
	Indicate that a unique final output is produced. More...

bool	produces_a_metadata
	Indicate that the unique final output file is a Metadata. More...

bool	each_image_produces_an_output
	Indicate that an output is produced for each image in the input. More...

bool	allow_apply_geo

bool	decompose_stacks
	Input Metadata will treat a stack file as a set of images instead of a unique file. More...

bool	delete_output_stack
	Delete previous output stack file prior to process images. More...

bool	get_image_info
	Get the input image file dimensions to further operations. More...

bool	save_metadata_stack
	Save the associated output metadata when output file is a stack. More...

bool	track_origin
	Include the original input image filename in the output stack. More...

bool	keep_input_columns
	Keep input metadata columns. More...

bool	remove_disabled
	Remove disabled images from the input selfile. More...

bool	allow_time_bar
	Show process time bar. More...

bool	input_is_metadata
	Input is a metadata. More...

bool	single_image
	Input is a single image. More...

bool	input_is_stack
	Input is a stack. More...

bool	output_is_stack
	Output is a stack. More...

bool	create_empty_stackfile

bool	delete_mdIn

size_t	time_bar_step
	Some time bar related counters. More...

size_t	time_bar_size

size_t	time_bar_done

Protected Attributes inherited from XmippProgram
int	errorCode

ProgramDef *	progDef
	Program definition and arguments parser. More...

std::map< String, CommentList >	defaultComments

int	argc
	Original command line arguments. More...

const char **	argv

Additional Inherited Members
Public Member Functions inherited from XmippMetadataProgram
MetaData *	getInputMd ()

MetaDataVec &	getOutputMd ()

	XmippMetadataProgram ()
	Empty constructor. More...

virtual int	tryRead (int argc, const char **argv, bool reportErrors=true)

virtual void	init ()

virtual void	setup (MetaData *md, const FileName &o="", const FileName &oroot="", bool applyGeo=false, MDLabel label=MDL_IMAGE)

virtual	~XmippMetadataProgram ()

void	setMode (WriteModeMetaData _mode)

void	setupRowOut (const FileName &fnImgIn, const MDRow &rowIn, const FileName &fnImgOut, MDRow &rowOut) const
	Prepare rowout. More...

virtual void	wait ()
	Wait for the distributor to finish. More...

virtual void	checkPoint ()
	For very long programs, it may be needed to write checkpoints. More...

virtual void	run ()
	Run over all images. More...

Public Member Functions inherited from XmippProgram
const char *	getParam (const char *param, int arg=0)

const char *	getParam (const char param, const char subparam, int arg=0)

int	getIntParam (const char *param, int arg=0)

int	getIntParam (const char param, const char subparam, int arg=0)

double	getDoubleParam (const char *param, int arg=0)

double	getDoubleParam (const char param, const char subparam, int arg=0)

float	getFloatParam (const char *param, int arg=0)

float	getFloatParam (const char param, const char subparam, int arg=0)

void	getListParam (const char *param, StringVector &list)

int	getCountParam (const char *param)

bool	checkParam (const char *param)

bool	existsParam (const char *param)

void	addParamsLine (const String &line)

void	addParamsLine (const char *line)

ParamDef *	getParamDef (const char *param) const

virtual void	quit (int exit_code=0) const

virtual int	tryRun ()

void	initProgress (size_t total, size_t stepBin=60)

void	setProgress (size_t value=0)

void	endProgress ()

void	processDefaultComment (const char param, const char left)

void	setDefaultComment (const char param, const char comment)

void	setProgramName (const char *name)

void	addUsageLine (const char *line, bool verbatim=false)

void	clearUsage ()

void	addExampleLine (const char *example, bool verbatim=true)

void	addSeeAlsoLine (const char *seeAlso)

void	addKeywords (const char *keywords)

const char *	name () const

virtual void	usage (int verb=0) const

virtual void	usage (const String &param, int verb=2)

int	version () const

virtual void	read (int argc, const char **argv, bool reportErrors=true)

virtual void	read (int argc, char **argv, bool reportErrors=true)

void	read (const String &argumentsLine)

	XmippProgram ()

	XmippProgram (int argc, const char **argv)

virtual	~XmippProgram ()

Public Attributes inherited from XmippMetadataProgram
FileName	fn_in
	Filenames of input and output Metadata. More...

FileName	fn_out

FileName	baseName

FileName	pathBaseName

FileName	oextBaseName

bool	apply_geo
	Apply geo. More...

size_t	ndimOut
	Output dimensions. More...

size_t	zdimOut

size_t	ydimOut

size_t	xdimOut

DataType	datatypeOut

size_t	mdInSize
	Number of input elements. More...

Public Attributes inherited from XmippProgram
bool	doRun

bool	runWithoutArgs

int	verbose
	Verbosity level. More...

int	debug

Detailed Description

Definition at line 31 of file transform_add_noise.cpp.

Member Function Documentation

◆ defineParams()

void ProgAddNoise::defineParams ( )

inlineprotectedvirtual

Function in which the param of each Program are defined.

Reimplemented from XmippMetadataProgram.

Definition at line 42 of file transform_add_noise.cpp.

     {
         each_image_produces_an_output = true;
         XmippMetadataProgram::defineParams();
         //Usage
         addUsageLine("Add random noise to the input images.");
         addUsageLine("Noise can be generated using uniform, gaussian or t-student distributions.");
         //Parameters
         addParamsLine("--type <rand_mode>                : Type of noise to add");
         addParamsLine("       where <rand_mode>");
         addParamsLine("              gaussian <stddev> <avg=0.>     :Gaussian distribution parameters");
         addParamsLine("              student <df> <stddev> <avg=0.> :t-student distribution parameters");
         addParamsLine("              uniform  <min> <max>           :Uniform distribution parameters");
         addParamsLine("              " + TYPE_POISSON + "  <min> <max>          :Poission distribution. Each pixel i of output is generated as poisson(ref-input[i])");
         addParamsLine("  [--limit0 <float> ]               :Crop noise histogram below this value ");
         addParamsLine("  [--limitF <float> ]               :Crop noise histogram above this value ");
         //Examples
         addExampleLine("Add noise to a single image, writing in different image:", false);
         addExampleLine("xmipp_transform_add_noise -i cleanImage.spi --type gaussian 10 5 -o noisyGaussian.spi");
         addExampleLine("+++Following =cleanImage.spi= at left and =noisyGaussian.spi= at right: %BR%", false);
         addExampleLine("+++%ATTACHURL%/cleanImage.jpg %ATTACHURL%/noisyGaussian.jpg  %BR%", false);
         addExampleLine("Add uniform noise to a volume, overriding input volume:", false);
         addExampleLine("xmipp_transform_add_noise -i g0ta.vol -uniform -0.1 0.1");
 
     }

◆ limit()

template<typename T >

void ProgAddNoise::limit ( Image< T > & img )

inlineprotected

Definition at line 130 of file transform_add_noise.cpp.

                               {
         if (do_limit0) {
             const size_t count = img.data.nzyxdim;
             for (size_t i = 0; i < count; ++i) {
                 img.data[i] = XMIPP_MAX(img.data[i], limit0);
             }
         }
         if (do_limitF) {
             const size_t count = img.data.nzyxdim;
             for (size_t i = 0; i < count; ++i) {
                 img.data[i] = XMIPP_MIN(img.data[i], limitF);
             }
         }
     }

◆ processImage()

void ProgAddNoise::processImage	(	const FileName &	fnImg,
		const FileName &	fnImgOut,
		const MDRow &	rowIn,
		MDRow &	rowOut
	)

inlineprotectedvirtual

Implements XmippMetadataProgram.

Definition at line 145 of file transform_add_noise.cpp.

     {
 
         if (TYPE_POISSON == noise_type) {
             Image<float> img;
             img.read(fnImg);
             std::random_device rd;
             std::mt19937 gen(rd());
             Image<int> res(img.data.xdim, img.data.ydim, img.data.zdim, img.data.ndim);
             const size_t count = res.data.nzyxdim;
             const float gap = param1 - param2;
             auto dist = std::poisson_distribution<>(0);
             for (size_t i = 0; i < count; ++i) {
                 float mean = param1 - gap * img.data[i];
                 if (dist.mean() != mean) { // reuse distribution, if possible
                     dist = std::poisson_distribution<>(mean);
                 }
                 res.data[i] = dist(gen);
             }
             limit(res);
             res.write(fnImgOut);
         } else {
             Image<double> img;
             img.read(fnImg);
             img().addNoise(param1, param2, noise_type, df);
             limit(img);
             img.write(fnImgOut);
         }
 
     }

◆ readParams()

void ProgAddNoise::readParams ( )

inlineprotectedvirtual

Function in which each program will read parameters that it need. If some error occurs the usage will be printed out.

Default value of df in addNoise function

Reimplemented from XmippMetadataProgram.

Definition at line 68 of file transform_add_noise.cpp.

     {
         XmippMetadataProgram::readParams();
         do_limit0 = checkParam("--limit0");
         if (do_limit0)
             limit0 =  getDoubleParam("-limit0");
         do_limitF = checkParam("--limitF");
         if (do_limitF)
             limitF =  getDoubleParam("--limitF");
 
         df = 3.;
         noise_type = getParam("--type");
 
         if (noise_type == "gaussian")
         {
             param2 = getDoubleParam("--type", 1);
             param1 = getDoubleParam("--type", 2);
         }
         else if (noise_type == "student")
         {
             df = getDoubleParam("--type", 1);
             param1 = getDoubleParam("--type", 2);
             param2 = getDoubleParam("--type", 3);
         }
         else if (noise_type == "uniform")
         {
             param1 = getDoubleParam("--type", 1);
             param2 = getDoubleParam("--type", 2);
         }
         else if (TYPE_POISSON == noise_type)
         {
             param1 = getDoubleParam("--type", 1);
             param2 = getDoubleParam("--type", 2);
         }
         else
             REPORT_ERROR(ERR_ARG_INCORRECT, "Unknown noise type");
     }

◆ show()

void ProgAddNoise::show ( )

inlineprotected

Definition at line 107 of file transform_add_noise.cpp.

     {
         XmippMetadataProgram::show();
         if (noise_type == "gaussian")
             std::cout << "Noise avg=" << param1 << std::endl
             << "Noise stddev=" << param2 << std::endl;
         else if (noise_type == "student")
             std::cout << "Degrees of freedom= "<< df << std::endl
             << "Noise avg=" << param1 << std::endl
             << "Noise stddev=" << param2 << std::endl;
         else if (noise_type == "uniform")
             std::cout << "Noise min=" << param1 << std::endl
             << "Noise max=" << param2 << std::endl;
         else if (TYPE_POISSON == noise_type)
             std::cout << "Mean background=" << param1 << std::endl
                         << "Mean foreground=" << param2 << std::endl;
         if (do_limit0)
             std::cout << "Crop noise histogram below=" << limit0 << std::endl;
         if (do_limitF)
             std::cout << "Crop noise histogram above=" << limitF << std::endl;
     }

Member Data Documentation

◆ df

double ProgAddNoise::df

protected

Definition at line 38 of file transform_add_noise.cpp.

◆ do_limit0

bool ProgAddNoise::do_limit0

protected

Definition at line 39 of file transform_add_noise.cpp.

◆ do_limitF

bool ProgAddNoise::do_limitF

protected

Definition at line 39 of file transform_add_noise.cpp.

◆ limit0

double ProgAddNoise::limit0

protected

Definition at line 38 of file transform_add_noise.cpp.

◆ limitF

double ProgAddNoise::limitF

protected

Definition at line 38 of file transform_add_noise.cpp.

◆ noise_type

std::string ProgAddNoise::noise_type

protected

Definition at line 40 of file transform_add_noise.cpp.

◆ param1

double ProgAddNoise::param1

protected

Definition at line 37 of file transform_add_noise.cpp.

◆ param2

double ProgAddNoise::param2

protected

Definition at line 37 of file transform_add_noise.cpp.

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

xmipp/libraries/reconstruction/transform_add_noise.cpp

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ defineParams()

◆ limit()

◆ processImage()

◆ readParams()

◆ show()

Member Data Documentation

◆ df

◆ do_limit0

◆ do_limitF

◆ limit0

◆ limitF

◆ noise_type

◆ param1

◆ param2