Model for a panorama. More...

#include <Panorama.h>

Inheritance diagram for HuginBase::Panorama:

Public Member Functions
	Panorama ()
	ctor.

	~Panorama ()
	dtor.

Panorama	getSubset (const UIntSet &imgs) const
	get a subset of the panorama

Panorama	duplicate () const
	duplicate the panorama

PanoramaData *	getNewSubset (const UIntSet &imgs) const

PanoramaData *	getNewCopy () const

PanoramaData *	getUnlinkedSubset (UIntSetVector &imageGroups) const
	get a panorama, which does not contain images linked with positions, the cps are moved to the first image of each linked stacked

std::size_t	getNrOfImages () const
	number of images.

const SrcPanoImage &	getImage (std::size_t nr) const
	get a panorama image, counting starts with 0

void	setImage (std::size_t nr, const SrcPanoImage &img)
	set a panorama image, counting starts with 0

unsigned int	addImage (const SrcPanoImage &img)
	the the number for a specific image

void	mergePanorama (const Panorama &newPano)
	merges the panorama with the given pano

void	removeImage (unsigned int nr)
	creates an image, from filename, and a Lens, if needed

void	swapImages (unsigned int img1, unsigned int img2)
	swap images.

void	moveImage (size_t img1, size_t img2)
	moves images.

SrcPanoImage	getSrcImage (unsigned imgNr) const
	get a description of a source image

void	setSrcImage (unsigned int nr, const SrcPanoImage &img)
	set input image parameters

void	setImageFilename (unsigned int img, const std::string &fname)
	set a new image filename

void	activateImage (unsigned int imgNr, bool active=true)
	mark an image as active or inactive.

UIntSet	getActiveImages () const
	get active images

std::size_t	getNrOfCtrlPoints () const
	number of control points

const ControlPoint &	getCtrlPoint (std::size_t nr) const
	get a control point, counting starts with 0

const CPVector &	getCtrlPoints () const
	get all control point of this Panorama

std::vector< unsigned int >	getCtrlPointsForImage (unsigned int imgNr) const
	return all control points for a given image.

CPointVector	getCtrlPointsVectorForImage (unsigned int imgNr) const
	return a vector of std::pairs with global ctrl point nr and ControlPoint In the class ControlPoint the image with imgNr is always image1

void	setCtrlPoints (const CPVector &points)
	set all control points (Ippei: Is this supposed to be 'add' method?)

unsigned int	addCtrlPoint (const ControlPoint &point)
	add a new control point.

void	removeCtrlPoint (unsigned int pNr)
	remove a control point.

void	removeDuplicateCtrlPoints ()
	removes duplicates control points

void	changeControlPoint (unsigned int pNr, const ControlPoint &point)
	change a control Point.

int	getNextCPTypeLineNumber () const
	get the number of a control point

void	updateLineCtrlPoints ()
	assign new mode line numbers, if required

void	updateCtrlPointErrors (const CPVector &controlPoints)
	update control points distances.

void	updateCtrlPointErrors (const UIntSet &imgs, const CPVector &cps)
	update control points for a subset of images.

const std::string	getICCProfileDesc () const
	return description of icc profile used for pano

void	setICCProfileDesc (const std::string &newDesc)
	sets the icc profile description for check of same profile

const int	getNrOfBands () const
	return number of bands of first image (without alpha channel) so it can be 1 for grayscale or 3 for rgb images

void	setNrOfBands (const int nrBands)
	sets the number of bands

VariableMapVector	getVariables () const
	get variables of this panorama

const VariableMap	getImageVariables (unsigned int imgNr) const
	Get the variables of an image.

virtual void	updateVariables (const VariableMapVector &vars)
	Set the variables.

virtual void	updateVariables (const UIntSet &imgs, const VariableMapVector &var)
	update variables for some specific images

virtual void	updateVariables (unsigned int imgNr, const VariableMap &var)
	Set variables for a single picture.

virtual void	updateVariable (unsigned int imgNr, const Variable &var)
	update a single variable

virtual void	UpdateFocalLength (UIntSet imgs, double newFocalLength)
	updates the focal length by changing hfov

virtual void	UpdateCropFactor (UIntSet imgs, double newCropFactor)
	updates the crop factor, try to keep focal length constant

virtual void	updateWhiteBalance (double redFactor, double blueFactor)
	update the global white balace of the panorama by multiplying the red and blue factor of each image with given factors

const double	getMaxExposureDifference () const
	returns the maximum exposure value difference of all images in the project

const bool	hasPossibleStacks () const
	return true, if the metadata indicates that the projects is a bracketet project

void	linkPossibleStacks (bool linkPosition)
	create automatically stacks as indicated by metadata

const OptimizeVector &	getOptimizeVector () const
	return the optimize settings stored inside panorama

void	setOptimizeVector (const OptimizeVector &optvec)
	set optimize setting

const int	getOptimizerSwitch () const
	returns optimizer master switch

void	setOptimizerSwitch (const int newSwitch)
	set optimizer master switch

const int	getPhotometricOptimizerSwitch () const
	return the photometric optimizer master switch

void	setPhotometricOptimizerSwitch (const int newSwitch)
	sets the photometric optimizer master switch

const PanoramaOptions &	getOptions () const
	returns the options for this panorama

void	setOptions (const PanoramaOptions &opt)
	set new output settings This is not used directly for optimizing/stiching, but it can be feed into runOptimizer() and runStitcher().

void	printPanoramaScript (std::ostream &o, const OptimizeVector &optvars, const PanoramaOptions &options, const UIntSet &imgs, bool forPTOptimizer, const std::string &stripPrefix="") const
	create an optimizer script

void	printStitcherScript (std::ostream &o, const PanoramaOptions &target, const UIntSet &imgs) const
	create the stitcher script

void	addObserver (PanoramaObserver *o)
	add a panorama observer.

bool	removeObserver (PanoramaObserver *observer)
	remove a panorama observer.

void	clearObservers ()
	remove all panorama observers.

const bool	hasPendingChanges () const
	return if the panorama class has pending changes normally all controls listen to panoramaChanges notification and react only there, but the fast preview window also reacts to changes in the Redraw procedure to handle the tools like drag or crop, use this as workaround (it does not include all changes)

void	changeFinished (bool keepDirty)
	notify observers about changes in this class

void	changeFinished ()
	notify observers about changes in this class

void	imageChanged (unsigned int imgNr)
	mark image for change notification.

void	updateMasksForImage (unsigned int imgNr, MaskPolygonVector newMasks)
	set complete mask list for image with number

void	updateMasks (bool convertPosMaskToNeg=false)
	updates all active masks

void	transferMask (MaskPolygon mask, unsigned int imgNr, const UIntSet &targetImgs)
	transfers given mask from image imgNr to all targetImgs

void	updateOptimizeVector ()
	updates the optimize vector according to master switches

std::set< size_t >	getRefImages ()
	returns set of reference image and images linked with reference images

void	checkRefOptStatus (bool &linkRefImgsYaw, bool &linkRefImgsPitch, bool &linkRefImgsRoll)
	checks if yaw/pitch/roll of reference image can be check, it depends on number and type of control points

virtual PanoramaDataMemento *	getNewMemento () const
	get the internal state

virtual bool	setMementoToCopyOf (const PanoramaDataMemento *const memento)
	set the internal state

PanoramaMemento	getMemento () const
	get the internal state

void	setMemento (const PanoramaMemento &memento)
	set the internal state

bool	needsOptimization ()
	true if control points or lens variables have been changed after the last optimisation

void	markAsOptimized (bool optimized=true)

bool	ReadPTOFile (const std::string &filename, const std::string &prefix="")
	read pto file from the given filename into Panorama object it does some checks on the file and issues warnings to std::cerr

bool	WritePTOFile (const std::string &filename, const std::string &prefix="")
	write data to given pto file

bool	isDirty () const
	true if there are unsaved changes

virtual void	clearDirty ()
	clear dirty flag.

void	setFilePrefix (std::string prefix)
	sets the path prefix of the images reffered with relative paths

void	reset ()
	clear the internal state.

Public Member Functions inherited from HuginBase::ManagedPanoramaData
virtual	~ManagedPanoramaData ()

Public Member Functions inherited from HuginBase::PanoramaData
virtual	~PanoramaData ()

Public Member Functions inherited from AppBase::DocumentData
virtual	~DocumentData ()

Protected Member Functions
void	setDirty (const bool &dirty=true)

std::string	getFilePrefix () const

void	adjustVarLinks ()
	adjust the links of the linked variables, must be called when a lens has been changed.

Private Member Functions
void	centerCrop (unsigned int imgNr)
	center the crop for given image and all linked images

vigra::Rect2D	centerCropImage (unsigned int imgNr)
	return the centered crop for given image

void	updateCropMode (unsigned int imgNr)
	update the crop mode in dependence of crop rect and lens projection

Private Attributes
std::string	imgFilePrefix

bool	dirty
	this indicates that there are unsaved changes

PanoramaMemento	state

std::list< PanoramaObserver * >	observers

UIntSet	changedImages
	the images that have been changed since the last changeFinished()

bool	m_forceImagesUpdate

std::set< std::string >	m_ptoptimizerVarNames

Detailed Description

Model for a panorama.

This class contains the properties of a panorama That is:

images
variables that can be optimized including links between them
control points
properites of the output panorama.

view and controller classes can get information about these with the getXXX Functions.

Images and Control points are numbered, and const references are handed out. this means that all interaction will be based on image/control point numbers. The references are not stable, they might disappear when other functions of this class are called, so its best to get a new reference whenever you need the object.

This also means that the whole object is not threadsafe and concurrent access has to be synchronized from the outside.

Changes should be made through command objects, not with direct calls.

Todo:: should the changer call the report() functions?

Todo:: should we add constraints for the simple / advanced functionality to the model? I have to think a bit more about that issue. maybe the contraints can be factored out into another class that corrects then when updating. or we could have different models.. SimplePanorama and AdvancedPanorama.

also, it is useful to use the memento pattern for the internal state, so that redo/undo for complex interactions can be implemented without too much pain.

Definition at line 152 of file Panorama.h.

Constructor & Destructor Documentation

◆ Panorama()

HuginBase::Panorama::Panorama ( )

ctor.

Definition at line 41 of file Panorama.cpp.

References m_ptoptimizerVarNames.

◆ ~Panorama()

HuginBase::Panorama::~Panorama ( )

dtor.

Definition at line 62 of file Panorama.cpp.

References DEBUG_TRACE, and reset().

Member Function Documentation

◆ activateImage()

void HuginBase::Panorama::activateImage	(	unsigned int	imgNr,
		bool	active = `true`
	)

virtual

mark an image as active or inactive.

This is only a flag, that can be turned on or off. If an image is marked active, then it should be used for optimizing and stitching.

However, this is not done automatically. One has to use getActiveImages() to get the numbers of the active images, and pass these to the respective functions that do the stitching or optimisation

bool HuginBase::Panorama::ReadPTOFile	(	const std::string &	filename,
		const std::string &	prefix = `""`
	)

filename	the filename from which is pto file is read
prefix	path prefix to use for filepath mangling

bool HuginBase::Panorama::WritePTOFile	(	const std::string &	filename,
		const std::string &	prefix = `""`
	)

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Panorama()

◆ ~Panorama()

Member Function Documentation

◆ activateImage()

◆ addCtrlPoint()

◆ addImage()

◆ addObserver()

◆ adjustVarLinks()

◆ centerCrop()

◆ centerCropImage()

◆ changeControlPoint()

◆ changeFinished() [1/2]

◆ changeFinished() [2/2]

◆ checkRefOptStatus()

◆ clearDirty()

◆ clearObservers()

◆ duplicate()

◆ getActiveImages()

◆ getCtrlPoint()

◆ getCtrlPoints()

◆ getCtrlPointsForImage()

◆ getCtrlPointsVectorForImage()

◆ getFilePrefix()

◆ getICCProfileDesc()

◆ getImage()

◆ getImageVariables()

◆ getMaxExposureDifference()

◆ getMemento()

◆ getNewCopy()

◆ getNewMemento()

◆ getNewSubset()

◆ getNextCPTypeLineNumber()

◆ getNrOfBands()

◆ getNrOfCtrlPoints()

◆ getNrOfImages()

◆ getOptimizerSwitch()

◆ getOptimizeVector()

◆ getOptions()

◆ getPhotometricOptimizerSwitch()

◆ getRefImages()

◆ getSrcImage()

◆ getSubset()

◆ getUnlinkedSubset()

◆ getVariables()

◆ hasPendingChanges()

◆ hasPossibleStacks()

◆ imageChanged()

◆ isDirty()

◆ linkPossibleStacks()

◆ markAsOptimized()

◆ mergePanorama()

◆ moveImage()

◆ needsOptimization()

◆ printPanoramaScript()

◆ printStitcherScript()

◆ ReadPTOFile()

◆ removeCtrlPoint()

◆ removeDuplicateCtrlPoints()

◆ removeImage()

◆ removeObserver()

◆ reset()

◆ setCtrlPoints()

◆ setDirty()

◆ setFilePrefix()

◆ setICCProfileDesc()

◆ setImage()

◆ setImageFilename()

◆ setMemento()

◆ setMementoToCopyOf()

◆ setNrOfBands()

◆ setOptimizerSwitch()

◆ setOptimizeVector()

◆ setOptions()

◆ setPhotometricOptimizerSwitch()