pyfmt2 Namespace Reference

Utility functions for writing Python code snippets. More...

Functions
std::string	argumentList (const IParametricComponent *ip)
	Returns comma-separated list of parameter values, including unit multiplicator (like "* nm"). More...
std::string	printAxis (const IAxis *axis, const std::string &unit)
	Prints an axis. More...
std::string	printDistribution (const IDistribution1D &par_distr, const std::string &units)
	Prints distribution with constructor parameters in given units. More...
std::string	printParameterDistribution (const ParameterDistribution &par_distr, const std::string &distVarName, const std::string &units)
std::string	printRangedDistribution (const IRangedDistribution &distr)
std::string	representShape2D (const std::string &indent, const IShape2D *ishape, bool mask_value, std::function< std::string(double)> printValueFunc)
	Returns fixed Python code snippet that defines the function "runSimulation". More...
std::string	valueTimesUnit (const RealParameter *par)
	Returns parameter value, followed by its unit multiplicator (like "* nm"). More...

Detailed Description

Utility functions for writing Python code snippets.

Function Documentation

argumentList()

std::string pyfmt2::argumentList

(

const IParametricComponent *

ip

)

Returns comma-separated list of parameter values, including unit multiplicator (like "* nm").

Definition at line 106 of file PyFmt2.cpp.

{
    std::vector<std::string> args;
    for (const auto* par : ip->parameterPool()->parameters())
        args.push_back(valueTimesUnit(par));
    return StringUtils::join(args, ", ");
}

References StringUtils::join(), IParametricComponent::parameterPool(), ParameterPool::parameters(), and valueTimesUnit().

Referenced by SampleToPython::defineFormFactors(), SampleToPython::defineInterferenceFunctions(), SampleToPython::defineRoughnesses(), and printDistribution().

Here is the call graph for this function:

printAxis()

std::string pyfmt2::printAxis	(	const IAxis *	axis,
		const std::string &	unit
	)

Prints an axis.

Definition at line 115 of file PyFmt2.cpp.

{
    std::ostringstream result;
    if (const auto* a = dynamic_cast<const FixedBinAxis*>(axis); a)
        result << "ba.FixedBinAxis(" << pyfmt::printString(a->getName()) << ", " << a->size()
               << ", " << pyfmt::printValue(a->lowerBound(), unit) << ", "
               << pyfmt::printValue(a->upperBound(), unit) << ")";
    else if (const auto* a = dynamic_cast<const PointwiseAxis*>(axis); a) {
        result << "numpy.asarray([";
        const std::vector<double>& points = a->binCenters();
        for (auto iter = points.begin(); iter != points.end() - 1; ++iter) {
            result << pyfmt::printValue(*iter, unit) << ",";
        }
        result << pyfmt::printValue(points.back(), unit) << "])\n";
    } else
        throw std::runtime_error("printAxis not implemented for current axis type");
    return result.str();
}

References pyfmt::printString(), and pyfmt::printValue().

Here is the call graph for this function:

printDistribution()

std::string pyfmt2::printDistribution	(	const IDistribution1D &	par_distr,
		const std::string &	units
	)

Prints distribution with constructor parameters in given units.

ba.DistributionGaussian(2.0*deg, 0.02*deg)

Definition at line 137 of file PyFmt2.cpp.

{
    std::unique_ptr<IDistribution1D> distr(par_distr.clone());
    distr->setUnits(units);
 
    std::ostringstream result;
    result << "ba." << distr->getName() << "(" << argumentList(distr.get()) << ")";
    return result.str();
}

References argumentList(), and IDistribution1D::clone().

Referenced by SampleToPython::defineParticleDistributions().

Here is the call graph for this function:

printParameterDistribution()

std::string pyfmt2::printParameterDistribution	(	const ParameterDistribution &	par_distr,
		const std::string &	distVarName,
		const std::string &	units
	)

Definition at line 147 of file PyFmt2.cpp.

{
    std::ostringstream result;
 
    result << "ba.ParameterDistribution("
           << "\"" << par_distr.getMainParameterName() << "\""
           << ", " << distVarName << ", " << par_distr.getNbrSamples() << ", "
           << pyfmt::printDouble(par_distr.getSigmaFactor())
           << pyfmt::printRealLimitsArg(par_distr.getLimits(), units) << ")";
 
    return result.str();
}

References ParameterDistribution::getLimits(), ParameterDistribution::getMainParameterName(), ParameterDistribution::getNbrSamples(), ParameterDistribution::getSigmaFactor(), pyfmt::printDouble(), and pyfmt::printRealLimitsArg().

Referenced by SampleToPython::defineParticleDistributions().

Here is the call graph for this function:

printRangedDistribution()

std::string pyfmt2::printRangedDistribution

(

const IRangedDistribution &

distr

)

Definition at line 161 of file PyFmt2.cpp.

{
    std::ostringstream result;
    result << pyfmt::indent() << "distribution = ba.";
    result << distr.name();
    result << "(" << distr.nSamples() << ", " << pyfmt::printDouble(distr.sigmaFactor());
    if (!distr.limits().isLimitless())
        result << pyfmt::printRealLimitsArg(distr.limits());
    result << ")";
    return result.str();
}

References pyfmt::indent(), RealLimits::isLimitless(), IRangedDistribution::limits(), IRangedDistribution::name(), IRangedDistribution::nSamples(), pyfmt::printDouble(), pyfmt::printRealLimitsArg(), and IRangedDistribution::sigmaFactor().

Here is the call graph for this function:

representShape2D()

std::string pyfmt2::representShape2D	(	const std::string &	indent,
		const IShape2D *	ishape,
		bool	mask_value,
		std::function< std::string(double)>	printValueFunc
	)

Returns fixed Python code snippet that defines the function "runSimulation".

Definition at line 40 of file PyFmt2.cpp.

{
    std::ostringstream result;
    result << std::setprecision(12);
 
    if (const Polygon* shape = dynamic_cast<const Polygon*>(ishape)) {
        std::vector<double> xpos, ypos;
        shape->getPoints(xpos, ypos);
        result << indent << "points = [";
        for (size_t i = 0; i < xpos.size(); ++i) {
            result << "[" << printValueFunc(xpos[i]) << ", " << printValueFunc(ypos[i]) << "]";
            if (i != xpos.size() - 1)
                result << ", ";
        }
        result << "]\n";
        result << indent << "simulation.addMask("
               << "ba.Polygon(points), " << pyfmt::printBool(mask_value) << ")\n";
 
    } else if (dynamic_cast<const InfinitePlane*>(ishape)) {
        result << indent << "simulation.maskAll()\n";
 
    } else if (const Ellipse* shape = dynamic_cast<const Ellipse*>(ishape)) {
        result << indent << "simulation.addMask(";
        result << "ba.Ellipse(" << printValueFunc(shape->getCenterX()) << ", "
               << printValueFunc(shape->getCenterY()) << ", " << printValueFunc(shape->getRadiusX())
               << ", " << printValueFunc(shape->getRadiusY());
        if (shape->getTheta() != 0.0)
            result << ", " << pyfmt::printDegrees(shape->getTheta());
        result << "), " << pyfmt::printBool(mask_value) << ")\n";
    }
 
    else if (const Rectangle* shape = dynamic_cast<const Rectangle*>(ishape)) {
        result << indent << "simulation.addMask(";
        result << "ba.Rectangle(" << printValueFunc(shape->getXlow()) << ", "
               << printValueFunc(shape->getYlow()) << ", " << printValueFunc(shape->getXup())
               << ", " << printValueFunc(shape->getYup()) << "), " << pyfmt::printBool(mask_value)
               << ")\n";
    }
 
    else if (const VerticalLine* shape = dynamic_cast<const VerticalLine*>(ishape)) {
        result << indent << "simulation.addMask(";
        result << "ba.VerticalLine(" << printValueFunc(shape->getXpos()) << "), "
               << pyfmt::printBool(mask_value) << ")\n";
    }
 
    else if (const HorizontalLine* shape = dynamic_cast<const HorizontalLine*>(ishape)) {
        result << indent << "simulation.addMask(";
        result << "ba.HorizontalLine(" << printValueFunc(shape->getYpos()) << "), "
               << pyfmt::printBool(mask_value) << ")\n";
 
    } else
        throw std::runtime_error("representShape2D(const IShape2D*) -> Error. Unknown shape");
 
    return result.str();
}

References pyfmt::indent(), pyfmt::printBool(), and pyfmt::printDegrees().

Here is the call graph for this function:

valueTimesUnit()

std::string pyfmt2::valueTimesUnit

(

const RealParameter *

par

)

Returns parameter value, followed by its unit multiplicator (like "* nm").

Definition at line 99 of file PyFmt2.cpp.

{
    return pyfmt::printValue(par->value(), par->unit());
}

References pyfmt::printValue(), RealParameter::unit(), and RealParameter::value().

Referenced by argumentList().

Here is the call graph for this function: