Dispatcher

xicsrt.objects._Dispatcher.Dispatcher

New Members

class Dispatcher(config=None, section=None)

Bases: object

A class to help find, initialize and then dispatch calls to raytracing objects.

A dispatcher is used within XICSRT to find and instantiate objects based on their specification within the config dictionary. These objects are then tracked within the dispatcher, allowing methods to be called on all objects sequentially.

__init__(config=None, section=None)

Initialize self. See help(type(self)) for accurate signature.

instantiate(names=None)

find_xicsrt_objects(pathlist)

Return a dictionary with all the XICSRT objects found in the given list of paths. Objects are identified by looking for python files that start with ‘_Xicsrt’ prefix.

Programming Notes

If a given path does not exist glob will just return and empty list. For this reason no path existence checking is needed (unless we want to raise a user friendly error).

get_object(name)

check_config(*args, **kwargs)

check_param(*args, **kwargs)

get_config(*args, **kwargs)

setup(*args, **kwargs)

initialize(*args, **kwargs)

generate_rays(keep_meta=None, keep_history=None)

Generates rays from all sources.

trace(rays, keep_meta=None, keep_history=None, keep_images=None)

Perform raytracing for each object in sequence.

apply_filters(filters)

New Private Members

class Dispatcher

__init__(config=None, section=None)

Initialize self. See help(type(self)) for accurate signature.

_instantiate_single(obj_info, config, strict=None)

Instantiate an object from a list of filenames and a class name.

Inherited Members

class Dispatcher

__init__(config=None, section=None)

Initialize self. See help(type(self)) for accurate signature.

_instantiate_single(obj_info, config, strict=None)

Instantiate an object from a list of filenames and a class name.

apply_filters(filters)

check_config(*args, **kwargs)

check_param(*args, **kwargs)

find_xicsrt_objects(pathlist)

Return a dictionary with all the XICSRT objects found in the given list of paths. Objects are identified by looking for python files that start with ‘_Xicsrt’ prefix.

Programming Notes

If a given path does not exist glob will just return and empty list. For this reason no path existence checking is needed (unless we want to raise a user friendly error).

generate_rays(keep_meta=None, keep_history=None)

Generates rays from all sources.

get_config(*args, **kwargs)

get_object(name)

initialize(*args, **kwargs)

instantiate(names=None)

setup(*args, **kwargs)

trace(rays, keep_meta=None, keep_history=None, keep_images=None)

Perform raytracing for each object in sequence.