pyfmt Namespace Reference

Functions
std::string	scriptPreamble ()
std::string	getSampleFunctionName ()
std::string	printBool (double value)
std::string	printDouble (double input)
std::string	printNm (double input)
std::string	printNm2 (double input)
std::string	printScientificDouble (double input)
std::string	printDegrees (double input)
std::string	printValue (double value, const std::string &units)
std::string	printString (const std::string &value)
bool	isSquare (double length1, double length2, double angle)
bool	isHexagonal (double length1, double length2, double angle)
std::string	printKvector (const kvector_t value)
std::string	indent (size_t width=4u)
std::string	printInt (int value)
std::string	printRealLimits (const RealLimits &limits, const std::string &units)
std::string	printRealLimitsArg (const RealLimits &limits, const std::string &units)

Detailed Description

Utility functions for writing Python code snippets.

Function Documentation

scriptPreamble()

std::string pyfmt::scriptPreamble

(

)

Definition at line 24 of file PyFmt.cpp.

{
    const std::string result = "import numpy\n"
                               "import bornagain as ba\n"
                               "from bornagain import deg, angstrom, nm, nm2, kvector_t\n\n\n";
 
    return result;
}

Referenced by SimulationToPython::generateSimulationCode().

getSampleFunctionName()

std::string pyfmt::getSampleFunctionName

(

)

Definition at line 33 of file PyFmt.cpp.

{
    return "get_sample";
}

Referenced by SampleToPython::defineGetSample().

printBool()

std::string pyfmt::printBool

(

double

value

)

Definition at line 38 of file PyFmt.cpp.

{
    return value ? "True" : "False";
}

Referenced by pyfmt2::representShape2D().

printDouble()

std::string pyfmt::printDouble

(

double

input

)

Definition at line 43 of file PyFmt.cpp.

{
    std::ostringstream inter;
    inter << std::setprecision(12);
    if (std::abs(input) < std::numeric_limits<double>::epsilon()) {
        inter << "0.0";
        return inter.str();
    }
    inter << input;
    if (inter.str().find('e') == std::string::npos && inter.str().find('.') == std::string::npos)
        inter << ".0";
    return inter.str();
}

Referenced by SimulationToPython::defineBeamPolarization(), SimulationToPython::defineDetector(), SimulationToPython::defineDetectorPolarizationAnalysis(), SampleToPython::defineInterferenceFunctions(), SampleToPython::defineMaterials(), SimulationToPython::defineParameterDistributions(), SampleToPython::defineParticleLayouts(), AngularSpecScan::print(), FootprintGauss::print(), FootprintSquare::print(), anonymous_namespace{SimulationToPython.cpp}::printFunc(), printKvector(), printNm(), printNm2(), pyfmt2::printParameterDistribution(), anonymous_namespace{ScanResolution.cpp}::ScanSingleRelativeResolution::printStdDevs(), anonymous_namespace{ScanResolution.cpp}::ScanSingleAbsoluteResolution::printStdDevs(), printValue(), RangedDistribution::pyString(), and pyfmt2::valueTimesUnit().

printNm()

std::string pyfmt::printNm

(

double

input

)

Definition at line 57 of file PyFmt.cpp.

{
    std::ostringstream inter;
    inter << std::setprecision(12);
    inter << printDouble(input) << "*nm";
    return inter.str();
}

References printDouble().

Referenced by SimulationToPython::defineGISASBeam(), SampleToPython::defineInterferenceFunctions(), SampleToPython::defineLattices(), SimulationToPython::defineOffSpecBeam(), printValue(), and SampleToPython::setPositionInformation().

Here is the call graph for this function:

printNm2()

std::string pyfmt::printNm2

(

double

input

)

Definition at line 65 of file PyFmt.cpp.

{
    std::ostringstream inter;
    inter << std::setprecision(12);
    inter << printDouble(input) << "*nm2";
    return inter.str();
}

References printDouble().

Referenced by SampleToPython::defineInterferenceFunctions().

Here is the call graph for this function:

printScientificDouble()

std::string pyfmt::printScientificDouble

(

double

input

)

Definition at line 74 of file PyFmt.cpp.

{
    std::ostringstream inter;
    inter << std::scientific;
    inter << input;
 
    std::string::size_type pos = inter.str().find('e');
    if (pos == std::string::npos)
        return inter.str();
 
    std::string part1 = inter.str().substr(0, pos);
    std::string part2 = inter.str().substr(pos, std::string::npos);
 
    part1.erase(part1.find_last_not_of('0') + 1, std::string::npos);
    if (part1.back() == '.')
        part1 += "0";
 
    return part1 + part2;
}

References StringUtils::scientific().

Referenced by SimulationToPython::defineBackground(), SimulationToPython::defineBeamIntensity(), and SampleToPython::defineMultiLayers().

Here is the call graph for this function:

printDegrees()

std::string pyfmt::printDegrees

(

double

input

)

Definition at line 94 of file PyFmt.cpp.

{
    std::ostringstream inter;
    inter << std::setprecision(11) << Units::rad2deg(input);
    if (inter.str().find('e') == std::string::npos && inter.str().find('.') == std::string::npos)
        inter << ".0";
    inter << "*deg";
    return inter.str();
}

References Units::rad2deg().

Referenced by SimulationToPython::defineDetector(), SimulationToPython::defineGISASBeam(), SampleToPython::defineInterferenceFunctions(), SimulationToPython::defineOffSpecBeam(), anonymous_namespace{SimulationToPython.cpp}::printFunc(), printValue(), pyfmt2::representShape2D(), SampleToPython::setRotationInformation(), and pyfmt2::valueTimesUnit().

Here is the call graph for this function:

printValue()

std::string pyfmt::printValue	(	double	value,
		const std::string &	units
	)

Definition at line 104 of file PyFmt.cpp.

{
    if (units == "rad")
        return printDegrees(value);
    else if (units == "nm")
        return printNm(value);
    else if (units == "")
        return printDouble(value);
    else
        throw std::runtime_error("pyfmt::printValue() -> Error. Unknown units '" + units + "'");
}

References printDegrees(), printDouble(), and printNm().

Referenced by printRealLimits(), PointwiseAxis::pyString(), and FixedBinAxis::pyString().

Here is the call graph for this function:

printString()

std::string pyfmt::printString

(

const std::string &

value

)

Definition at line 116 of file PyFmt.cpp.

{
    std::ostringstream result;
    result << "\"" << value << "\"";
    return result.str();
}

Referenced by FixedBinAxis::pyString().

isSquare()

bool pyfmt::isSquare	(	double	length1,
		double	length2,
		double	angle
	)

Definition at line 123 of file PyFmt.cpp.

{
    return length1 == length2 && algo::almostEqual(angle, M_PI_2);
}

References algo::almostEqual(), and M_PI_2.

Here is the call graph for this function:

isHexagonal()

bool pyfmt::isHexagonal	(	double	length1,
		double	length2,
		double	angle
	)

Definition at line 128 of file PyFmt.cpp.

{
    return length1 == length2 && algo::almostEqual(angle, M_TWOPI / 3.0);
}

References algo::almostEqual(), and M_TWOPI.

Here is the call graph for this function:

printKvector()

std::string pyfmt::printKvector

(

const kvector_t

value

)

Definition at line 133 of file PyFmt.cpp.

{
    std::ostringstream result;
    result << "kvector_t(" << printDouble(value.x()) << ", " << printDouble(value.y()) << ", "
           << printDouble(value.z()) << ")";
    return result.str();
}

References printDouble(), BasicVector3D< T >::x(), BasicVector3D< T >::y(), and BasicVector3D< T >::z().

Referenced by SimulationToPython::defineDetector().

Here is the call graph for this function:

indent()

std::string pyfmt::indent

(

size_t

width = 4u

)

Returns a string of blanks with given width.

By default the width equals standard offset in python files.

Definition at line 141 of file PyFmt.cpp.

{
    return std::string(width, ' ');
}

References anonymous_namespace{BoxCompositionBuilder.cpp}::width.

Referenced by SimulationToPython::defineBackground(), SimulationToPython::defineBeamIntensity(), SimulationToPython::defineBeamPolarization(), SimulationToPython::defineDetector(), SimulationToPython::defineDetectorPolarizationAnalysis(), SimulationToPython::defineDetectorResolutionFunction(), SimulationToPython::defineGetSimulation(), SimulationToPython::defineGISASBeam(), SimulationToPython::defineGISASSimulation(), SimulationToPython::defineMasks(), SimulationToPython::defineOffSpecBeam(), SimulationToPython::defineOffSpecSimulation(), SimulationToPython::defineParameterDistributions(), SimulationToPython::defineSimulationOptions(), SimulationToPython::defineSpecularScan(), SimulationToPython::defineSpecularSimulation(), ScanResolution::print(), AngularSpecScan::print(), QSpecScan::print(), FootprintGauss::print(), FootprintSquare::print(), RangedDistribution::pyString(), PointwiseAxis::pyString(), and pyfmt2::representShape2D().

printInt()

std::string pyfmt::printInt

(

int

value

)

printRealLimits()

std::string pyfmt::printRealLimits	(	const RealLimits &	limits,
		const std::string &	units
	)

Definition at line 23 of file PyFmtLimits.cpp.

{
    std::ostringstream result;
 
    if (limits.isLimitless()) {
        result << "RealLimits()";
    }
 
    else if (limits.isPositive()) {
        result << "RealLimits.positive()";
    }
 
    else if (limits.isNonnegative()) {
        result << "RealLimits.nonnegative()";
    }
 
    else if (limits.isLowerLimited()) {
        result << "RealLimits.lowerLimited(" << pyfmt::printValue(limits.lowerLimit(), units)
               << ")";
    }
 
    else if (limits.isUpperLimited()) {
        result << "RealLimits.upperLimited(" << pyfmt::printValue(limits.upperLimit(), units)
               << ")";
    }
 
    else if (limits.isLimited()) {
        result << "RealLimits.limited(" << pyfmt::printValue(limits.lowerLimit(), units) << ", "
               << pyfmt::printValue(limits.upperLimit(), units) << ")";
    }
 
    return result.str();
}

References RealLimits::isLimited(), RealLimits::isLimitless(), RealLimits::isLowerLimited(), RealLimits::isNonnegative(), RealLimits::isPositive(), RealLimits::isUpperLimited(), RealLimits::lowerLimit(), printValue(), and RealLimits::upperLimit().

Referenced by printRealLimitsArg().

Here is the call graph for this function:

printRealLimitsArg()

std::string pyfmt::printRealLimitsArg	(	const RealLimits &	limits,
		const std::string &	units
	)

Prints RealLimits in the form of argument (in the context of ParameterDistribution and similar).

Default RealLimits will not be printed, any other will be printed as ", ba.RealLimits.limited(1*deg, 2*deg)"

Definition at line 61 of file PyFmtLimits.cpp.

{
    return limits.isLimitless() ? "" : ", ba." + printRealLimits(limits, units);
}

References RealLimits::isLimitless(), and printRealLimits().

Referenced by SimulationToPython::defineParameterDistributions(), pyfmt2::printParameterDistribution(), and RangedDistribution::pyString().

Here is the call graph for this function: