def __init__(self,
inputGeometry=None,
genBsdfParameters=None,
gridBasedParameters=None,
outputFile=None,
normalOrientation=None,
prepareGeometry=True):
RadianceCommand.__init__(self, executableName='genBSDF.pl')
self.gridBasedParameters = gridBasedParameters
"""The input for this attribute must be an instance of Grid based parameters"""
self.genBsdfParameters = genBsdfParameters
"""These are parameters specific to genBsdf such as sampling, geometry dimensions
etc."""
self.inputGeometry = inputGeometry
"""Rad or mgf files that are inputs for genBSDF"""
self.outputFile = outputFile
"""Path name for the XML file created by genBSDF"""
self.normalOrientation = normalOrientation
"""Direction of the normal surface for the overall input geometry"""
self.prepareGeometry = prepareGeometry
"""A boolean value to decide if the input geometry needs to be translated and
def __init__(self, outputName="untitled", octreeFile=None, pointFile=None,
simulationType=0, radianceParameters=None):
"""Initialize the class."""
# Initialize base class to make sure path to radiance is set correctly
RadianceCommand.__init__(self)
self.outputFile = outputName if outputName.lower().endswith(".res") \
else outputName + ".res"
"""oct file name which is usually the same as the project name (Default: untitled)"""
self.octreeFile = octreeFile
"""Full path to input oct file."""
self.pointFile = pointFile
"""Full path to input points file."""
self.radianceParameters = radianceParameters
"""Radiance parameters for this analysis (Default: RadianceParameters.LowQuality)."""
# add -h to parameters to get no header, True is no header
self.radianceParameters.addRadianceBoolFlag("h", "output header switch")
self.radianceParameters.h = True
# add error file as an extra parameter for rtrace.
# this can be added under default radiance parameters later.
self.radianceParameters.addRadianceValue("e", "error output file")
self.radianceParameters.e = "error.txt"
"""Error log file."""
self.simulationType = simulationType
"""Simulation type: 0: Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela)
def __init__(self,
useOpenGl=None,
hemisphereUp=None,
backFaceVisibility=None,
viewDetails=None,
numProcessors=None,
outputDevice=None,
verboseDisplay=None,
disableWarnings=None,
glRadFullScreen=None,
viewFile=None,
sceneExposure=None,
noLights=None,
runSilently=None,
printViews=None,
sceneFiles=None):
RadianceCommand.__init__(self, executableName='objview.pl')
self.useOpenGl = useOpenGl
self.hemisphereUp = hemisphereUp
self.backFaceVisibility = backFaceVisibility
self.viewDetails = viewDetails
self.numProcessors = numProcessors
self.outputDevice = outputDevice
self.verboseDisplay = verboseDisplay
self.disableWarnings = disableWarnings
self.glRadFullScreen = glRadFullScreen
self.viewFile = viewFile
self.sceneExposure = sceneExposure
self.noLights = noLights
self.runSilently = runSilently
self.printViews = printViews
self.sceneFiles = sceneFiles
def __init__(self, output_name=None, wea_file=None, gendaymtx_parameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.output_name = output_name
self.wea_file = wea_file
self.gendaymtx_parameters = gendaymtx_parameters
def __init__(self, outputName='untitled', octreeFile=None, pointsFile=None,
simulationType=0, radianceParameters=None):
"""Initialize the class."""
# Initialize base class to make sure path to radiance is set correctly
RadianceCommand.__init__(self)
self.outputFile = outputName if outputName.lower().endswith(".res") \
else outputName + ".res"
"""oct file name which is usually the same as the project name (Default: untitled)"""
self.octreeFile = octreeFile
"""Full path to input oct file."""
self.pointsFile = pointsFile
"""Full path to input points file."""
self.radianceParameters = radianceParameters
"""Radiance parameters for this analysis (Default: RadianceParameters.LowQuality)."""
# add -h to parameters to get no header, True is no header
self.radianceParameters.addRadianceBoolFlag("h", "output header switch")
self.radianceParameters.h = True
# add error file as an extra parameter for rtrace.
# this can be added under default radiance parameters later.
self.radianceParameters.addRadianceValue("e", "error output file")
self.radianceParameters.e = "error.txt"
"""Error log file."""
self.simulationType = simulationType
"""Simulation type: 0: Illuminance(lux), 1: Radiation (kWh), 2: Luminance (Candela)
def __init__(self,
use_open_gl=None,
hemisphere_up=None,
back_face_visibility=None,
view_details=None,
num_processors=None,
output_device=None,
verbose_display=None,
disable_warnings=None,
gl_rad_full_screen=None,
view_file=None,
scene_exposure=None,
no_lights=None,
run_silently=None,
print_views=None,
scene_files=None):
RadianceCommand.__init__(self, executable_name='objview.pl')
self.use_open_gl = use_open_gl
self.hemisphere_up = hemisphere_up
self.back_face_visibility = back_face_visibility
self.view_details = view_details
self.num_processors = num_processors
self.output_device = output_device
self.verbose_display = verbose_display
self.disable_warnings = disable_warnings
self.gl_rad_full_screen = gl_rad_full_screen
self.view_file = view_file
self.scene_exposure = scene_exposure
self.no_lights = no_lights
self.run_silently = run_silently
self.print_views = print_views
self.scene_files = scene_files
def __index__(self,outputName=None,matrixFile=None,rcollateParameters=None):
"""Init command"""
RadianceCommand.__init__(self)
self.outputName = outputName
self.matrixFile = matrixFile
self.rcollateParameters = rcollateParameters
def __init__(self, sender=None, receiverFile=None, octreeFile=None,
radFiles=None, pointsFile=None, outputMatrix=None):
RadianceCommand.__init__(self)
self.sender = sender
"""Sender file will be either a rad file containing rfluxmtx variables
or just a - """
self.receiverFile = receiverFile
"""Receiver file will usually be the sky file containing rfluxmtx
variables"""
self.octreeFile = octreeFile
"""Octree file containing the other rad file in the scene."""
self.radFiles = radFiles
"""Rad files other than the sender and receiver that are a part of the
scene."""
self.pointsFile = pointsFile
"""The points file or input vwrays for which the illuminance/luminance
value are to be calculated."""
self.outputMatrix = outputMatrix
"""The flux matrix file that will be created by rfluxmtx."""
self.pointsFileData = ''
def __init__(self, rad_file=None, xform_parameters=None, output_file=None,
transforms=None):
RadianceCommand.__init__(self)
self.rad_file = rad_file
self.xform_parameters = xform_parameters
self.output_file = output_file
self.transforms = transforms
def __init__(self,radFile=None,xformParameters=None,outputFile=None,
transforms=None):
RadianceCommand.__init__(self)
self.radFile = radFile
self.xformParameters = xformParameters
self.outputFile = outputFile
self.transforms = transforms
def __init__(self,
image_list=None,
output_file=None,
pcomb_parameters=None):
RadianceCommand.__init__(self)
self.image_list = image_list
self.output_file = output_file
self.pcomb_parameters = pcomb_parameters
def __init__(self,
imageList=None,
outputImageFile=None,
pcombParameters=None):
RadianceCommand.__init__(self)
self.imageList = imageList
self.outputImageFile = outputImageFile
self.pcombParameters = pcombParameters
def __init__(self, epwFile=None, outputWeaFile=None):
RadianceCommand.__init__(self)
self.epwFile = epwFile
"""The path of the epw file that is to be converted to a wea file."""
self.outputWeaFile = outputWeaFile
"""The path of the output wea file. Note that this path will be created
def __init__(self, input_hdr_file=None, output_bmp_file=None,
ra_bmp_parameters=None):
RadianceCommand.__init__(self, executable_name='ra_bmp.exe')
self.input_hdr_file = input_hdr_file
"""Path for input HDR file"""
self.output_bmp_file = output_bmp_file
"""Path for output tiff file"""
self.ra_bmp_parameters = ra_bmp_parameters
"""An instance of RaBmp parameters"""
def __init__(self, epw_file=None, output_wea_file=None):
RadianceCommand.__init__(self)
self.epw_file = epw_file
"""The path of the epw file that is to be converted to a wea file."""
self.output_wea_file = output_wea_file
"""The path of the output wea file. Note that this path will be created
def __init__(self,transpose=None,scalarFactors=None,transformCoefficients=None,matrixFile=None):
RadianceCommand.__init__(self,'rmtxop')
self.transpose = transpose
"""Set this to true to transpose the matrix"""
self.scalarFactors = scalarFactors
"""Scalar values for resizing the elements of the matrix. If a single value is specified then it will
be applied across the board."""
self.transformCoefficients = transformCoefficients
self.matrixFile = matrixFile
def __init__(self, warnings_suppress=None, header_suppress=None, rad_files=None,
output_file=None):
"""Init command."""
RadianceCommand.__init__(self)
self.warnings_suppress = warnings_suppress
self.header_suppress = header_suppress
self.rad_files = rad_files
self.output_file = output_file
def __init__(self, transpose=None, scalar_factors=None, transform_coefficients=None,
matrix_file=None):
RadianceCommand.__init__(self, 'rmtxop')
self.transpose = transpose
"""Set this to true to transpose the matrix"""
self.scalar_factors = scalar_factors
"""Scalar values for resizing the elements of the matrix. If a single value is
specified then it will be applied across the board."""
self.transform_coefficients = transform_coefficients
self.matrix_file = matrix_file
def __init__(self, get_dimensions=None, header_suppress=None, rad_files=None,
output_file=None):
"""Init command."""
RadianceCommand.__init__(self)
self.get_dimensions = get_dimensions
self.header_suppress = header_suppress
self.input_file = rad_files
self.output_file = output_file
def __init__(self,
outputName=None,
weaFile=None,
gendaymtxParameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.outputName = outputName
self.weaFile = weaFile
self.gendaymtxParameters = gendaymtxParameters
def __init__(self,
inputHdrFile=None,
outputBmpFile=None,
raBmpParameters=None):
RadianceCommand.__init__(self, executableName='ra_bmp.exe')
self.inputHdrFile = inputHdrFile
"""Path for input HDR file"""
self.outputBmpFile = outputBmpFile
"""Path for output tiff file"""
self.raBmpParameters = raBmpParameters
"""An instance of RaBmp parameters"""
def __init__(self, matrix_files=None, rmtxop_matrices=None,
output_file=None, rmtxop_parameters=None):
RadianceCommand.__init__(self)
self.matrix_files = matrix_files
self.output_file = output_file
self.rmtxop_parameters = rmtxop_parameters
self.rmtxop_matrices = rmtxop_matrices
def __init__(self,
original_pixel_use=None,
scaling_factor=None,
rgb_color_multiplier=None,
input_image_file=None):
RadianceCommand.__init__(self, 'pcomb')
self.original_pixel_use = original_pixel_use
self.scaling_factor = scaling_factor
self.rgb_color_multiplier = rgb_color_multiplier
self.input_image_file = input_image_file
def __init__(self, header_suppress=None, sky_subdivision=None, sky_color_rgb=None,
sun_only_vector=None, input_sky_file=None, output_file=None):
RadianceCommand.__init__(self, executable_name='genskyvec.pl')
self.header_suppress = header_suppress
self.sky_subdivision = sky_subdivision
self.sky_color_rgb = sky_color_rgb
self.sun_only_vector = sun_only_vector
self.input_sky_file = input_sky_file
self.output_file = output_file
def __init__(self, input_image_file=None, output_file=None,
falsecolor_parameters=None):
RadianceCommand.__init__(self, executable_name='falsecolor.pl')
self.input_image_file = input_image_file
"""The file path for which the falsecolor image is to be created."""
self.output_file = output_file
"""The name of the output file."""
self.falsecolor_parameters = falsecolor_parameters
"""Paramters for the falsecolor command."""
def __init__(self,
originalPixelUse=None,
scalingFactor=None,
rgbColorMultiplier=None,
inputImageFile=None):
RadianceCommand.__init__(self, 'pcomb')
self.originalPixelUse = originalPixelUse
self.scalingFactor = scalingFactor
self.rgbColorMultiplier = rgbColorMultiplier
self.inputImageFile = inputImageFile
def __init__(self, matrixFiles=None, rmtxopMatrices=None,
outputFile=None, rmtxopParameters=None):
RadianceCommand.__init__(self)
self.matrixFiles = matrixFiles
self.outputFile = outputFile
self.rmtxopParameters = rmtxopParameters
self.rmtxopMatrices = rmtxopMatrices
def __init__(self, output_name='untitled', month_day_hour=None, rotation=0,
gensky_parameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.output_file = output_name if output_name.lower().endswith(".sky") \
else output_name + ".sky"
"""results file for sky (Default: untitled)"""
self.month_day_hour = month_day_hour
self.rotation = rotation
self.gensky_parameters = gensky_parameters
def __init__(self,
input_hdr_file=None,
output_tiff_file=None,
ra_tiff_parameters=None):
RadianceCommand.__init__(self, executable_name='ra_tiff.exe')
self.input_hdr_file = input_hdr_file
"""Path for input HDR file"""
self.output_tiff_file = output_tiff_file
"""Path for output tiff file"""
self.ra_tiff_parameters = ra_tiff_parameters
"""An instance of RaTiff parameters"""
def __init__(self, outputName='untitled', monthDayHour=None,
genskyParameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.outputFile = outputName if outputName.lower().endswith(".sky") \
else outputName + ".sky"
"""results file for sky (Default: untitled)"""
self.monthDayHour = monthDayHour
self.genskyParameters = genskyParameters
def __init__(self,
inputImageFile=None,
outputFile=None,
falsecolorParameters=None):
RadianceCommand.__init__(self, executableName='falsecolor.pl')
self.inputImageFile = inputImageFile
"""The file path for which the falsecolor image is to be created."""
self.outputFile = outputFile
"""The name of the output file."""
self.falsecolorParameters = falsecolorParameters
"""Paramters for the falsecolor command."""
def __init__(self,
warnings_suppress=None,
header_suppress=None,
rad_files=None,
output_file=None):
"""Init command."""
RadianceCommand.__init__(self)
self.warnings_suppress = warnings_suppress
self.header_suppress = header_suppress
self.rad_files = rad_files
self.output_file = output_file
def __init__(self, outputName="untitled", sceneFiles=[],
oconvParameters=None):
"""Initialize the class."""
# Initialize base class to make sure path to radiance is set correctly
RadianceCommand.__init__(self)
self.outputFile = outputName if outputName.lower().endswith(".oct") \
else outputName + ".oct"
"""results file for coefficients (Default: untitled)"""
self.sceneFiles = sceneFiles
"""Sorted list of full path to input rad files (Default: [])"""
self.oconvParameters = oconvParameters
"""Radiance parameters for oconv. If None Default parameters will be
def __init__(self,
outputName='untitled',
monthDayHour=None,
rotation=0,
genskyParameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.outputFile = outputName if outputName.lower().endswith(".sky") \
else outputName + ".sky"
"""results file for sky (Default: untitled)"""
self.monthDayHour = monthDayHour
self.rotation = 0
self.genskyParameters = genskyParameters
def __init__(self,
headerSuppress=None,
skySubdivision=None,
skyColorRgb=None,
sunOnlyVector=None,
inputSkyFile=None,
outputFile=None):
RadianceCommand.__init__(self, executableName='genskyvec.pl')
self.headerSuppress = headerSuppress
self.skySubdivision = skySubdivision
self.skyColorRgb = skyColorRgb
self.sunOnlyVector = sunOnlyVector
self.inputSkyFile = inputSkyFile
self.outputFile = outputFile
def __init__(self, outputName="untitled", octreeFile=None, pointsFile=None,
rcontribParameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.outputFile = outputName if outputName.lower().endswith(".dc") \
else outputName + ".dc"
"""results file for coefficients (Default: untitled)"""
self.octreeFile = octreeFile
"""Full path to input oct file."""
self.pointsFile = pointsFile
"""Full path to input points file."""
self.rcontribParameters = rcontribParameters
"""Radiance parameters for rcontrib. If None Default parameters will be
def __init__(self,
outputName="untitled",
octreeFile=None,
pointsFile=None,
rcontribParameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.outputFile = outputName if outputName.lower().endswith(".dc") \
else outputName + ".dc"
"""results file for coefficients (Default: untitled)"""
self.octreeFile = octreeFile
"""Full path to input oct file."""
self.pointsFile = pointsFile
"""Full path to input points file."""
self.rcontribParameters = rcontribParameters
"""Radiance parameters for rcontrib. If None Default parameters will be
def execute(self):
if self.prepareGeometry._value:
self.inputGeometry = [self.prepareGeometryForBsdf()]
RadianceCommand.execute(self)
def __init__(self, oct_file=None, mkpmap_parameters=None):
"""Init command."""
RadianceCommand.__init__(self)
self.oct_file = oct_file
self.mkpmap_parameters = mkpmap_parameters
def execute(self):
self.check_input_files(self.to_rad_string())
RadianceCommand.execute(self)
def execute(self):
self.checkInputFiles(self.toRadString())
RadianceCommand.execute(self)
def execute(self):
if self.prepare_geometry._value:
self.input_geometry = [self.prepare_geometry_for_bsdf()]
RadianceCommand.execute(self)
def execute(self):
self.check_input_files(self.to_rad_string())
RadianceCommand.execute(self)
