Reference guide #

`openalea.color.colormap` module#

Download the source file ../../../src/openalea/color/colormap.py.

Colormap class

class openalea.color.colormap.ColorMap(minval=0.0, maxval=1.0)[source]#

Bases: object

A RGB color map, between 2 colors defined in HSV code

Examples:

>>> minh,maxh = minandmax([height(i) for i in s2])
>>> colormap = ColorMap(minh,maxh)
>>> s3 = [ Shape(i.geometry, Material
>>>    (Color3(colormap(height(i))), 1), i.id)
>>>    for i in s2]

color(normedU)[source]#

Parameters:: normedU – todo

grey(u)[source]#

Parameters:: u
Returns:: todo

greycolor(normedU)[source]#

Parameters:: normedU – todo
Returns:: todo

normU(u)[source]#

Parameters:: u
Returns:: todo

`openalea.color.py_color` module#

Download the source file ../../../src/openalea/color/py_color.py.

Colormap Nodes

class openalea.color.py_color.BlackNode(inputs, outputs)[source]#

Bases: FixedColorNode

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.color.py_color.BlueNode(inputs, outputs)[source]#

Bases: FixedColorNode

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.color.py_color.ColorNode(inputs, outputs)[source]#

Bases: Node

Small color node

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.color.py_color.FixedColorNode(inputs, outputs)[source]#

Bases: Node

Small color node

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.color.py_color.GreenNode(inputs, outputs)[source]#

Bases: FixedColorNode

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.color.py_color.RedNode(inputs, outputs)[source]#

Bases: FixedColorNode

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.color.py_color.WhiteNode(inputs, outputs)[source]#

Bases: FixedColorNode

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.color.py_color.col_item(ind, color_list=[(0, 0, 0), (255, 0, 0), (0, 255, 0), (0, 0, 255), (255, 255, 0), (0, 255, 255), (255, 0, 255), (128, 255, 0), (0, 128, 255), (255, 0, 128), (0, 255, 128), (128, 0, 255), (255, 128, 0), (128, 128, 255), (255, 128, 128), (128, 255, 128), (255, 255, 255)])[source]#

openalea.color.py_color.color_map(val, minval=0, maxval=1, coul1=80, coul2=20)[source]#: todo

openalea.color.py_color.hsv(rgb_col)[source]#

openalea.color.py_color.random(alpha)[source]#

openalea.color.py_color.rgb(H, S, V, alpha)[source]#

openalea.color.py_color.rgb_color_map(value, minval=0, maxval=1, hue1=0, hue2=100, sat=220, val=220)[source]#: todo

`openalea.csv.pycsv` module #

Download the source file ../../../src/openalea/csv/pycsv.py.

`openalea.data.array.arrays` module#

Download the source file ../../../src/openalea/data/array/arrays.py.

Data Nodes

class openalea.data.array.arrays.PyArray[source]#

Bases: Node

Python array

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

codename = ['signed integer (1)', 'unsigned integer (1)', 'unicode character (2)', 'signed short (2)', 'unsigned short (2)', 'signed integer (2)', 'unsigned integer (2)', 'signed integer (4)', 'unsigned integer (4)', 'signed long long (8)', 'unsigned long long (8)', 'floating point (4)', 'floating point (8)']#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

typecodes = ['b', 'B', 'u', 'h', 'H', 'i', 'I', 'l', 'L', 'q', 'Q', 'f', 'd']#

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

`openalea.data.data` module#

Download the source file ../../../src/openalea/data/data.py.

Data Nodes

class openalea.data.data.Bool(ins, outs)[source]#

Bases: Node

Boolean value

Parameters:

ins – input 1
outs – input 2

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.DateTime(inputs=(), outputs=())[source]#

Bases: Node

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.Dict(inputs=(), outputs=())[source]#

Bases: Node

Python Dictionary

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.DirName(inputs=(), outputs=())[source]#

Bases: Node

A directory path

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.FileName(inputs=(), outputs=())[source]#

Bases: Node

A file path

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.Float(ins, outs)[source]#

Bases: Node

Parameters:

ins – The stored value
outs – todo

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.FloatScy(ins, outs)[source]#

Bases: Node

Float Variable

Parameters:

ins – The stored value in string format
outs – todo

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.Int(ins, outs)[source]#

Bases: Node

Int Node

Parameters:

ins – the stored value (default is zero)
outs – the integer value

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.List(inputs=(), outputs=())[source]#

Bases: Node

Python List

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.PackageDir(inputs=(), outputs=())[source]#

Bases: Node

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.Pair(inputs=(), outputs=())[source]#

Bases: Node

Python 2-uple generator

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.String(inputs=(), outputs=())[source]#

Bases: Node

String Variable

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.Text(inputs=(), outputs=())[source]#

Bases: Node

Text Variable

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.Tuple3(inputs=(), outputs=())[source]#

Bases: Node

Python 3-uple generator

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.data.Variable(inputs=(), outputs=())[source]#

Bases: Node

Transmit obj to output and display str as caption

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.data.data.list_select(items, index)[source]#: __getitem__

openalea.data.data.none()[source]#: None singleton

`openalea.data.dict.dicts` module#

Download the source file ../../../src/openalea/data/dict/dicts.py.

Data Nodes

class openalea.data.dict.dicts.Dict(inputs=(), outputs=())[source]#

Bases: Node

Python Dictionary

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.dict.dicts.EditDict(inputs=(), outputs=())[source]#

Bases: Node

Python Dictionary

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.dict.dicts.Pair(inputs=(), outputs=())[source]#

Bases: Node

Python 2-uple generator

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.dict.dicts.Tuple3(inputs=(), outputs=())[source]#

Bases: Node

Python 2-uple generator

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.data.dict.dicts.list_select(items, index)[source]#: __getitem__

`openalea.data.list.lists` module#

Download the source file ../../../src/openalea/data/list/lists.py.

Data Nodes

class openalea.data.list.lists.List(inputs=(), outputs=())[source]#

Bases: Node

Python List

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.list.lists.Slice(inputs=(), outputs=())[source]#

Bases: Node

Slice a Python list

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.data.list.lists.list_select(items, index)[source]#: __getitem__

`openalea.data.set.sets` module#

Download the source file ../../../src/openalea/data/set/sets.py.

Data Nodes

openalea.data.set.sets.py_add(set_, elt)[source]#: Add an element to a set.

openalea.data.set.sets.py_clear(set_)[source]#: Remove all elements from this set.

openalea.data.set.sets.py_difference(set1, set2)[source]#: Return the difference of two sets as a new sets.

openalea.data.set.sets.py_intersection(set1, set2)[source]#: Return the intersection of two sets as a new sets.

openalea.data.set.sets.py_issubset(set1, set2)[source]#: Report whether another set contains this set.

openalea.data.set.sets.py_issuperset(set1, set2)[source]#: Report whether this set contains another set.

openalea.data.set.sets.py_set(list_elt)[source]#: Build an unordered sequence of unique element.

openalea.data.set.sets.py_symmetric_difference(set1, set2)[source]#: Return the symmetric difference of two sets as a new set.

openalea.data.set.sets.py_union(set1, set2)[source]#: Return the union of two sets as a new set.

openalea.data.set.sets.py_update(set1, set2)[source]#: Update a set with the union of set1 and set2.

`openalea.data.tuple.tuples` module#

Download the source file ../../../src/openalea/data/tuple/tuples.py.

Data Nodes

class openalea.data.tuple.tuples.Pair(inputs=(), outputs=())[source]#

Bases: Node

Python 2-uple generator

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.tuple.tuples.Tuple(inputs=(), outputs=())[source]#

Bases: Node

Python Tuple

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.data.tuple.tuples.Tuple3(inputs=(), outputs=())[source]#

Bases: Node

Python 2-uple generator

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

`openalea.file.files` module#

Download the source file ../../../src/openalea/file/files.py.

File manipulation

class openalea.file.files.DirName(inputs=(), outputs=())[source]#

Bases: Node

Browser to select a directory name

Parameters:: object – a string representing a valid directory path name
Returns:: the directory path name (string)

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.file.files.FileName[source]#

Bases: object

Browser to select a file pathname

Parameters:: object – a file pathname
Returns:: the filename path string

class openalea.file.files.FileRead[source]#

Bases: object

Read a file as a string

read_contents(f)[source]#

class openalea.file.files.FileReadlines[source]#

Bases: FileRead

Read a file as a list of strings

read_contents(f)[source]#

class openalea.file.files.PackageDir(inputs=(), outputs=())[source]#

Bases: Node

Package dir

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.file.files.expanduser(pth)[source]#: Join several strings to form a path

openalea.file.files.glob(directory, pattern)[source]#

Return a list of path that match the pattern

Parameters:: pattern – a pattern to glob
Returns:: a list of paths that match the pattern

openalea.file.files.joinpath(pathlist)[source]#: Join several strings to form a path

openalea.file.files.listdir(dir='.', pattern=None)[source]#

openalea.file.files.parentdir(filename='.')[source]#

openalea.file.files.py_tmpnam()[source]#

openalea.file.files.py_write(x='', filename='', mode='w')[source]#: Write to a file

openalea.file.files.start(path)[source]#

`openalea.functional.functional` module#

Download the source file ../../../src/openalea/functional/functional.py.

Standard python functions for functional programming.

openalea.functional.functional.pyapply(func, seq, one_argument=False)[source]#: apply(func, seq)

openalea.functional.functional.pyfilter(func, seq)[source]#: filter(func, seq)

class openalea.functional.functional.pyfunction(ins, outs)[source]#

Bases: Node

Function method

Parameters:

ins – the function code
outs – the function object

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.functional.functional.pyifelse(val, cond, f, g)[source]#

openalea.functional.functional.pymap(func, seq)[source]#: map(func, seq)

openalea.functional.functional.pyreduce(func, seq)[source]#: reduce(func, seq)

`openalea.math.maths` module #

Download the source file ../../../src/openalea/math/maths.py.

`openalea.model.models` module#

Download the source file ../../../src/openalea/model/models.py.

Model nodes

openalea.model.models.linearmodel(x=0.0, a=0.0, b=0.0)[source]#: return a*x + b

`openalea.pickling.pickling` module#

Download the source file ../../../src/openalea/pickling/pickling.py.

Python Nodes

openalea.pickling.pickling.py_dump(data, file_path, append=False)[source]#

openalea.pickling.pickling.py_load(file_path)[source]#

`openalea.plotools.plotable` module#

Download the source file ../../../src/openalea/plotools/plotable.py.

Definition of plotable object

Mainly based on matplotlib.

todo:: Nothing.
bug:: None known.
organization:: INRIA

szymon.stoma 82471946

class openalea.plotools.plotable.VisualSequence(x=[], y=[], z=[], legend='', linestyle='', marker='', color='', bins=10, **keys)[source]#

Bases: object

Object containing basic plot information.

get_x()[source]#: Returrns the X array.

get_y()[source]#: Get the y array of values.

set_x(value)[source]#: Set the x array of values

set_y(value)[source]#: Set the y array of values.

property x#: Returrns the X array.

property y#: Get the y array of values.

openalea.plotools.plotable.change_VisualSequence_HistView(vis_seq, new_bins, new_color)[source]#

Returns vis_seq object with values changed from default

Parameters:

vis_seq (VisualSequence) – object to be modified
new_bins (int) – binning for the histogram
new_color (string) – a matplotlib color arg

Returns:

Updated object.

openalea.plotools.plotable.change_VisualSequence_PointLineView(vis_seq, new_legend, new_linestyle, new_marker, new_color)[source]#

Returns vis_seq object with values changed from default

Parameters:

vis_seqVisualSequence: object to be modified
new_legendstring: legend of a line
new_linestylestring: One of - : -. -
new_markerstring: One of + , o . s v x > <,
new_colorstring: A matplotlib color arg

Return type:

VisualSequence

Returns:

Updated object.

openalea.plotools.plotable.dict2VisualSequence(dict2vis_seq={}, marker='o', color='g', **keys)[source]#

generates visual sequence2D with keys as x and values as y

Parameters:

dict2vis_seq (dict{float:float}) – contains a list of object to display
marker (string) – the marker for the point-line
color (string) – the color

openalea.plotools.plotable.display_VisualSequence(vis_seq_list=[], visualisation='', title='', xlabel='', ylabel='', figure=0, **keys)[source]#

Plots 2D visual sequences.

Parameters:

vis_seq_listVisualSequence: Contains a list of object to display
titlestring: Title of the plot.
xlabelstring: X axis description
ylabelstring: Y label description

openalea.plotools.plotable.display_VisualSequence_as_Hist(vis_seq=[], title='', xlabel='', ylabel='', figure=0, **keys)[source]#

plots 2d visual sequences.

Parameters:

vis_seq (VisualSequence) – contains a list of object to display
title (string) – title of the plot
xlabel (string) – x-axis description
ylabel (string) – y-axis description
figure – figure’s number

openalea.plotools.plotable.display_VisualSequence_as_PointLine(vis_seq_list=[], title='', xlabel='', ylabel='', figure=0, **keys)[source]#

Plots 2D visual sequences.

Parameters:

vis_seq_listVisualSequence: Contains a list of object to display
titlestring: Title of the plot.
xlabelstring: X axis description
ylabelstring: Y label description

openalea.plotools.plotable.seqs2VisualSequence(seq1=[], seq2=[], marker='o', color='b', **keys)[source]#

generates visual sequence2D with list1 as x and list2 as y

Parameters:

seq1 (iterable) – contains the x-sequence
seq2 (iterable) – contains the y-sequence
marker (string) – the marker for the point-line
color (string) – the color

openalea.plotools.plotable.tuples2VisualSequence(seq1=[], marker='o', color='b', **keys)[source]#

generates visual sequence2D from a list a 2uples (x,y)

Parameters:

seq1 (iterable) – contains the list of (x,y)
marker (string) – the marker for the point-line
color (string) – the color

`openalea.python.python` module#

Download the source file ../../../src/openalea/python/python.py.

Python Nodes

class openalea.python.python.FileRead[source]#

Bases: object

Read a file

class openalea.python.python.PyGetItem(inputs=(), outputs=())[source]#

Bases: Node

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.python.python.extract(indexable, keys)[source]#: Extract from indexable object indexed by keys

openalea.python.python.items(obj)[source]#: call items() on obj

openalea.python.python.keys(obj)[source]#: call keys() on obj

openalea.python.python.py_delitem(obj, key)[source]#: call __delitem__ on obj

openalea.python.python.py_eval(str)[source]#: Python eval

openalea.python.python.py_exec(str)[source]#: Python exec

openalea.python.python.py_flatten(obj=[])[source]#: Flatten nested list

openalea.python.python.py_fwrite(x='', filename='', mode='w')[source]#: Write to a file

openalea.python.python.py_getattr(items, member_name)[source]#: getattr

openalea.python.python.py_ifelse(c=True, a=None, b=None)[source]#: Return a if c is true else b

openalea.python.python.py_method(obj=None, member_name='', args=())[source]#: call obj.name(*args)

openalea.python.python.py_print(x)[source]#: Print to the console

openalea.python.python.py_setattr(obj, member_name, value_str)[source]#

openalea.python.python.py_setitem(obj, index, value)[source]#: obj.__setitem__

openalea.python.python.py_zip(s1=(), s2=())[source]#

openalea.python.python.py_zip2(args)[source]#

openalea.python.python.pyenumerate(obj)[source]#: enumerate(iterable) -> iterator for index, value of iterable

openalea.python.python.pylen(obj)[source]#: len(obj)

openalea.python.python.pymean(sequence)[source]#

openalea.python.python.pyrange(start=0, stop=0, step=1)[source]#: range(start, stop, step)

openalea.python.python.pysum(sequence)[source]#

openalea.python.python.values(obj)[source]#: call values() on obj

`openalea.spatial.distribGen` module#

Download the source file ../../../src/openalea/spatial/distribGen.py.

Set of distributions

class openalea.spatial.distribGen.aggregative_distrib[source]#

Bases: Node

Basic distribution(type) -> distribution func

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

distr_func = {'NemanScott': <function neman_scott__distribution>}#

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.spatial.distribGen.basic_distrib[source]#

Bases: Node

Basic distribution(type) -> distribution func :input: Type of the function. :output: function that generates distribution.

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

distr_func = {'Random': <function random_distribution>, 'Regular': <function regular_distribution>}#

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

openalea.spatial.distribGen.domain(xmin, xmax, ymin, ymax, scale)[source]#

openalea.spatial.distribGen.gibbs_distrib(n=10, xr=(0, 1), yr=(0, 1))[source]#

openalea.spatial.distribGen.neman_scott__distrib(n=100, xr=(0, 1), yr=(0, 1), **kwds)[source]#: simulation d’une realisation du processus de type Neman Scott (Nb Agregats, Rayon Agregats)

openalea.spatial.distribGen.neman_scott__distribution(n=10, cl_nbr=2, cl_radius=0.2)[source]#: simulation d’une realisation du processus de type Neman Scott (Nb Agregats, Rayon Agregats)

openalea.spatial.distribGen.random2D(n, distrib_func, domain)[source]#

openalea.spatial.distribGen.random_distrib(n=100, xr=(0, 1), yr=(0, 1))[source]#

openalea.spatial.distribGen.random_distribution(n=10)[source]#

openalea.spatial.distribGen.regular_distrib(n=100, xr=(0, 1), yr=(0, 1))[source]#

Simulation d’une realisation du processus regulier correspondant a une proba lineaire fonction du rayon caracterisant l’espace disponible par point

Parameters:

n (int) – the number of random points to be generated
xr (tuple) – the x range, default is [0,1]
yr (tuple) – the y range, default is [0,1]

Returns:

two lists representing coordinates

Return type:

list

openalea.spatial.distribGen.regular_distribution(n=10)[source]#

openalea.spatial.distribGen.scale(seq, min, max)[source]#

openalea.spatial.distribGen.spatial_distrib(n=100, xrange=(0, 1), yrange=(0, 1), type='Random', params=None)[source]#

`openalea.stand.stand_modelling` module#

Download the source file ../../../src/openalea/stand/stand_modelling.py.

Set of spatial distribution for stands

openalea.stand.stand_modelling.best_position_mapping(objList=[], pts_distrib=[])[source]#

openalea.stand.stand_modelling.best_position_mapping_with_radius_deform(objList=[], pts_distrib=[])[source]#

openalea.stand.stand_modelling.gibbs(objList=[], pts_distrib=[])[source]#

openalea.stand.stand_modelling.position_mapping(objList=[], ptX=[], ptY=[])[source]#

openalea.stand.stand_modelling.stand_dresser(objList=[], dresser=None)[source]#

openalea.stand.stand_modelling.stand_positioner(objList=[], ptX=[], ptY=[], type='Position mapping (PM)', params=None)[source]#

`openalea.string.strings` module #

Download the source file ../../../src/openalea/string/strings.py.

`openalea.system.systemnodes` module#

Download the source file ../../../src/openalea/system/systemnodes.py.

System Nodes

openalea.system.systemnodes.shell_command(cmd, directory)[source]#: Execute a command in a shell cmd : the command as a string dir : the directory where the cmd is executed Output : status

openalea.system.systemnodes.system_cmd(str_list)[source]#: Execute a system command Input : a list of string Output : subprocess stdout, stderr

`openalea.system.ui_vprint` module#

Download the source file ../../../src/openalea/system/ui_vprint.py.

tobe done

class openalea.system.ui_vprint.Ui_Dialog[source]#

Bases: object

retranslateUi(Dialog)[source]#

setupUi(Dialog)[source]#

`openalea.system.vprint` module#

Download the source file ../../../src/openalea/system/vprint.py.

to be done

class openalea.system.vprint.VPrint(*args)[source]#

Bases: Node

Visual Print In 0 : The object to display In 1 : The caption of the display In 2 : The function to transform the object into a string (default=str) In 3 : Blocking display

Out 0 : The object

add_input(**kargs)#: Create an input port

add_output(**kargs)#: Create an output port

property block#: todo

property caption#: Return the node caption

clear_inputs()#

clear_outputs()#

close()#

copy_to(other)#

property delay#: todo

eval()#: Evaluate the node by calling __call__ Return True if the node needs a reevaluation and a timed delay if the node needs a reevaluation at a later time.

exclusive_command(who, command, *args, **kargs)#: Executes a call “command” and if it triggers any signal from this observed object along the way, “who” will be the only one to be notified

classmethod extend_ad_hoc_slots(name, _type, default, *args)#: Describes which data and what type are expected to be found in the ad_hoc dictionnary. Used by views.__ad_hoc_slots__ = {} Created at runtime __ad_hoc_from_old_map__ = {}.

get_ad_hoc_dict()#

get_block()#: todo

get_caption()#: Return the node caption

get_delay()#: todo

get_factory()#: Return the factory of the node (if any)

get_id()#

get_input(index_key)#: Return the input value for the specified index/key

get_input_port(name=None)#

Gets port by name.

Long description of the function functionality.

Parameters:: name (string) – the name of the port
Returns:: Input port characterized by name
Return type:: InputPort

get_input_state(index_key)#

get_lazy()#: todo

get_nb_input()#: Return the nb of input ports

get_nb_output()#: Return the nb of output ports

get_output(index_key)#: Return the output for the specified index/key

get_process_obj()#: Return the process obj

get_raise_exception()#

get_tip()#

get_user_application()#: todo

invalidate()#: Invalidate node

static is_deprecated_event(event)#

is_port_hidden(index_key)#: Return the hidden state of a port

property lazy#: todo

mimetype = 'openalea/node'#

notify_listeners(event)#

Send a notification to all listeners

Parameters:: event – an object to pass to the notify function

output(key)#

post_notification()#

property process_obj#: Return the process obj

property raise_exception#

register_listener(listener)#: Add listener to list of listeners. If the observed is currently notifying, the registration is delayed until it finishes.

reload()#: Reset ports

reset()#: Reset ports

set_block(data)#: todo

set_caption(newcaption)#: Define the node caption

set_compositenode(upper)#

set_data(key, value, notify=True)#: Set internal node data

set_delay(delay)#: todo

set_factory(factory)#: Set the factory of the node (if any) and uptdate caption

set_id(id)#

set_input(key, val=None, notify=True)#: Define the input value for the specified index/key

set_input_state(index_key, state)#: Set the state of the input index/key (state is a string)

set_io(inputs, outputs)#

Define the number of inputs and outputs

Parameters:

inputs – list of dict(name=’X’, interface=IFloat, value=0)
outputs – list of dict(name=’X’, interface=IFloat)

set_lazy(data)#: todo

set_output(key, val)#: Define the input value for the specified index/key

set_port_hidden(index_key, state)#

Set the hidden state of a port.

Parameters:

index_key – the input port index.
state – a boolean value.

set_raise_exception(val)#

set_user_application(data)#: todo

to_script()#: Script translation of this node.

transfer_listeners(newObs)#: Takes all this observed’s listeners, unregisters them from itself and registers them to the newObs, calling listener.change_observed if implemented

unregister_listener(listener)#: Remove listener from the list of listeners

unvalidate_input(index_key, notify=True)#

Unvalidate node and notify listeners.

This method is called when the input value has changed.

property user_application#: todo

class openalea.system.vprint.VisualPrintDialog(parent=None)[source]#

Bases: QDialog, Ui_Dialog

Accepted = 1#

class DialogCode#: Bases: int

DrawChildren = 2#

DrawWindowBackground = 1#

IgnoreMask = 4#

class PaintDeviceMetric#: Bases: int

PdmDepth = 6#

PdmDevicePixelRatio = 11#

PdmDevicePixelRatioScaled = 12#

PdmDpiX = 7#

PdmDpiY = 8#

PdmHeight = 2#

PdmHeightMM = 4#

PdmNumColors = 5#

PdmPhysicalDpiX = 9#

PdmPhysicalDpiY = 10#

PdmWidth = 1#

PdmWidthMM = 3#

Rejected = 0#

class RenderFlag#: Bases: int

class RenderFlags#
class RenderFlags(f: QWidget.RenderFlags | QWidget.RenderFlag)
class RenderFlags(a0: QWidget.RenderFlags): Bases: simplewrapper

accept(self)#

acceptDrops(self) → bool#

accepted#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

types is normally a sequence of individual types. Each type is either a type object or a string that is the name of a C++ type. Alternatively each type could itself be a sequence of types each describing a different overloaded signal. name is the optional C++ name of the signal. If it is not specified then the name of the class attribute that is bound to the signal is used. revision is the optional revision of the signal that is exported to QML. If it is not specified then 0 is used. arguments is the optional sequence of the names of the signal’s arguments.

Type:: pyqtSignal(*types, name
Type:: str = …, revision

accessibleDescription(self) → str#

accessibleName(self) → str#

actionEvent(self, a0: QActionEvent | None)#

actions(self) → list[QAction]#

activateWindow(self)#

addAction(self, action: QAction | None)#

addActions(self, actions: Iterable[QAction])#

adjustSize(self)#

autoFillBackground(self) → bool#

backgroundRole(self) → QPalette.ColorRole#

baseSize(self) → QSize#

blockSignals(self, b: bool) → bool#

changeEvent(self, a0: QEvent | None)#

childAt(self, p: QPoint) → QWidget | None#
childAt(self, ax: int, ay: int) → QWidget | None

childEvent(self, a0: QChildEvent | None)#

children(self) → list[QObject]#

childrenRect(self) → QRect#

childrenRegion(self) → QRegion#

clearFocus(self)#

clearMask(self)#

close(self) → bool#

closeEvent(self, a0: QCloseEvent | None)#

colorCount(self) → int#

connectNotify(self, signal: QMetaMethod)#

contentsMargins(self) → QMargins#

contentsRect(self) → QRect#

contextMenuEvent(self, a0: QContextMenuEvent | None)#

contextMenuPolicy(self) → Qt.ContextMenuPolicy#

create(self, window: PyQt5.sip.voidptr = None, initializeWindow: bool = True, destroyOldWindow: bool = True)#

createWindowContainer(window: QWindow | None, parent: QWidget | None = None, flags: Qt.WindowFlags | Qt.WindowType = 0) → QWidget#

cursor(self) → QCursor#

customContextMenuRequested#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

customEvent(self, a0: QEvent | None)#

deleteLater(self)#

depth(self) → int#

destroy(self, destroyWindow: bool = True, destroySubWindows: bool = True)#

destroyed#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

devType(self) → int#

devicePixelRatio(self) → int#

devicePixelRatioF(self) → float#

devicePixelRatioFScale() → float#

disconnect(a0: QMetaObject.Connection) → bool#
disconnect(self) → None

disconnectNotify(self, signal: QMetaMethod)#

done(self, a0: int)#

dragEnterEvent(self, a0: QDragEnterEvent | None)#

dragLeaveEvent(self, a0: QDragLeaveEvent | None)#

dragMoveEvent(self, a0: QDragMoveEvent | None)#

dropEvent(self, a0: QDropEvent | None)#

dumpObjectInfo(self)#

dumpObjectTree(self)#

dynamicPropertyNames(self) → list[QByteArray]#

effectiveWinId(self) → PyQt5.sip.voidptr#

ensurePolished(self)#

enterEvent(self, a0: QEvent | None)#

event(self, a0: QEvent | None) → bool#

eventFilter(self, a0: QObject | None, a1: QEvent | None) → bool#

exec(self) → int#

exec_(self) → int#

find(a0: PyQt5.sip.voidptr) → QWidget | None#

findChild(self, type: type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT#
findChild(self, types: tuple[type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → QObjectT

findChildren(self, type: type[QObjectT], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]#
findChildren(self, types: tuple[type[QObjectT], ...], name: str | None = '', options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]
findChildren(self, type: type[QObjectT], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]
findChildren(self, types: tuple[type[QObjectT], ...], regExp: QRegExp, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]
findChildren(self, type: type[QObjectT], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]
findChildren(self, types: tuple[type[QObjectT], ...], re: QRegularExpression, options: Qt.FindChildOptions | Qt.FindChildOption = Qt.FindChildrenRecursively) → list[QObjectT]

finished#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

focusInEvent(self, a0: QFocusEvent | None)#

focusNextChild(self) → bool#

focusNextPrevChild(self, next: bool) → bool#

focusOutEvent(self, a0: QFocusEvent | None)#

focusPolicy(self) → Qt.FocusPolicy#

focusPreviousChild(self) → bool#

focusProxy(self) → QWidget | None#

focusWidget(self) → QWidget | None#

font(self) → QFont#

fontInfo(self) → QFontInfo#

fontMetrics(self) → QFontMetrics#

foregroundRole(self) → QPalette.ColorRole#

frameGeometry(self) → QRect#

frameSize(self) → QSize#

geometry(self) → QRect#

getContentsMargins(self)#

grab(self, rectangle: QRect = QRect(QPoint(0, 0), QSize(-1, -1))) → QPixmap#

grabGesture(self, type: Qt.GestureType, flags: Qt.GestureFlags | Qt.GestureFlag = Qt.GestureFlags())#

grabKeyboard(self)#

grabMouse(self)#
grabMouse(self, a0: QCursor | Qt.CursorShape) → None

grabShortcut(self, key: QKeySequence | QKeySequence.StandardKey | str | None | int, context: Qt.ShortcutContext = Qt.WindowShortcut) → int#

graphicsEffect(self) → QGraphicsEffect | None#

graphicsProxyWidget(self) → QGraphicsProxyWidget | None#

hasFocus(self) → bool#

hasHeightForWidth(self) → bool#

hasMouseTracking(self) → bool#

hasTabletTracking(self) → bool#

height(self) → int#

heightForWidth(self, a0: int) → int#

heightMM(self) → int#

hide(self)#

hideEvent(self, a0: QHideEvent | None)#

inherits(self, classname: str | None) → bool#

initPainter(self, painter: QPainter | None)#

inputMethodEvent(self, a0: QInputMethodEvent | None)#

inputMethodHints(self) → Qt.InputMethodHints#

inputMethodQuery(self, a0: Qt.InputMethodQuery) → Any#

insertAction(self, before: QAction | None, action: QAction | None)#

insertActions(self, before: QAction | None, actions: Iterable[QAction])#

installEventFilter(self, a0: QObject | None)#

isActiveWindow(self) → bool#

isAncestorOf(self, child: QWidget | None) → bool#

isEnabled(self) → bool#

isEnabledTo(self, a0: QWidget | None) → bool#

isFullScreen(self) → bool#

isHidden(self) → bool#

isLeftToRight(self) → bool#

isMaximized(self) → bool#

isMinimized(self) → bool#

isModal(self) → bool#

isRightToLeft(self) → bool#

isSignalConnected(self, signal: QMetaMethod) → bool#

isSizeGripEnabled(self) → bool#

isVisible(self) → bool#

isVisibleTo(self, a0: QWidget | None) → bool#

isWidgetType(self) → bool#

isWindow(self) → bool#

isWindowModified(self) → bool#

isWindowType(self) → bool#

keyPressEvent(self, a0: QKeyEvent | None)#

keyReleaseEvent(self, a0: QKeyEvent | None)#

keyboardGrabber() → QWidget | None#

killTimer(self, id: int)#

layout(self) → QLayout | None#

layoutDirection(self) → Qt.LayoutDirection#

leaveEvent(self, a0: QEvent | None)#

locale(self) → QLocale#

logicalDpiX(self) → int#

logicalDpiY(self) → int#

lower(self)#

mapFrom(self, a0: QWidget | None, a1: QPoint) → QPoint#

mapFromGlobal(self, a0: QPoint) → QPoint#

mapFromParent(self, a0: QPoint) → QPoint#

mapTo(self, a0: QWidget | None, a1: QPoint) → QPoint#

mapToGlobal(self, a0: QPoint) → QPoint#

mapToParent(self, a0: QPoint) → QPoint#

mask(self) → QRegion#

maximumHeight(self) → int#

maximumSize(self) → QSize#

maximumWidth(self) → int#

metaObject(self) → QMetaObject | None#

metric(self, a0: QPaintDevice.PaintDeviceMetric) → int#

minimumHeight(self) → int#

minimumSize(self) → QSize#

minimumSizeHint(self) → QSize#

minimumWidth(self) → int#

mouseDoubleClickEvent(self, a0: QMouseEvent | None)#

mouseGrabber() → QWidget | None#

mouseMoveEvent(self, a0: QMouseEvent | None)#

mousePressEvent(self, a0: QMouseEvent | None)#

mouseReleaseEvent(self, a0: QMouseEvent | None)#

move(self, a0: QPoint)#
move(self, ax: int, ay: int) → None

moveEvent(self, a0: QMoveEvent | None)#

moveToThread(self, thread: QThread | None)#

nativeEvent(self, eventType: QByteArray | bytes | bytearray, message: PyQt5.sip.voidptr | None)#

nativeParentWidget(self) → QWidget | None#

nextInFocusChain(self) → QWidget | None#

normalGeometry(self) → QRect#

objectName(self) → str#

objectNameChanged#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

open(self)#

overrideWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)#

overrideWindowState(self, state: Qt.WindowStates | Qt.WindowState)#

paintEngine(self) → QPaintEngine | None#

paintEvent(self, a0: QPaintEvent | None)#

paintingActive(self) → bool#

palette(self) → QPalette#

parent(self) → QObject | None#

parentWidget(self) → QWidget | None#

physicalDpiX(self) → int#

physicalDpiY(self) → int#

pos(self) → QPoint#

previousInFocusChain(self) → QWidget | None#

property(self, name: str | None) → Any#

pyqtConfigure(...)#: Each keyword argument is either the name of a Qt property or a Qt signal. For properties the property is set to the given value which should be of an appropriate type. For signals the signal is connected to the given value which should be a callable.

raise_(self)#

receivers(self, signal: PYQT_SIGNAL) → int#

rect(self) → QRect#

reject(self)#

rejected#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

releaseKeyboard(self)#

releaseMouse(self)#

releaseShortcut(self, id: int)#

removeAction(self, action: QAction | None)#

removeEventFilter(self, a0: QObject | None)#

render(self, target: QPaintDevice | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren))#
render(self, painter: QPainter | None, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: QWidget.RenderFlags | QWidget.RenderFlag = QWidget.RenderFlags(QWidget.RenderFlag.DrawWindowBackground | QWidget.RenderFlag.DrawChildren)) → None

repaint(self)#
repaint(self, x: int, y: int, w: int, h: int) → None
repaint(self, a0: QRect) → None
repaint(self, a0: QRegion) → None

resize(self, a0: QSize)#
resize(self, w: int, h: int) → None

resizeEvent(self, a0: QResizeEvent | None)#

restoreGeometry(self, geometry: QByteArray | bytes | bytearray) → bool#

result(self) → int#

retranslateUi(Dialog)#

saveGeometry(self) → QByteArray#

screen(self) → QScreen | None#

scroll(self, dx: int, dy: int)#
scroll(self, dx: int, dy: int, a2: QRect) → None

sender(self) → QObject | None#

senderSignalIndex(self) → int#

setAcceptDrops(self, on: bool)#

setAccessibleDescription(self, description: str | None)#

setAccessibleName(self, name: str | None)#

setAttribute(self, attribute: Qt.WidgetAttribute, on: bool = True)#

setAutoFillBackground(self, enabled: bool)#

setBackgroundRole(self, a0: QPalette.ColorRole)#

setBaseSize(self, basew: int, baseh: int)#
setBaseSize(self, s: QSize) → None

setContentsMargins(self, left: int, top: int, right: int, bottom: int)#
setContentsMargins(self, margins: QMargins) → None

setContextMenuPolicy(self, policy: Qt.ContextMenuPolicy)#

setCursor(self, a0: QCursor | Qt.CursorShape)#

setDisabled(self, a0: bool)#

setEnabled(self, a0: bool)#

setFixedHeight(self, h: int)#

setFixedSize(self, a0: QSize)#
setFixedSize(self, w: int, h: int) → None

setFixedWidth(self, w: int)#

setFocus(self)#
setFocus(self, reason: Qt.FocusReason) → None

setFocusPolicy(self, policy: Qt.FocusPolicy)#

setFocusProxy(self, a0: QWidget | None)#

setFont(self, a0: QFont)#

setForegroundRole(self, a0: QPalette.ColorRole)#

setGeometry(self, a0: QRect)#
setGeometry(self, ax: int, ay: int, aw: int, ah: int) → None

setGraphicsEffect(self, effect: QGraphicsEffect | None)#

setHidden(self, hidden: bool)#

setInputMethodHints(self, hints: Qt.InputMethodHints | Qt.InputMethodHint)#

setLayout(self, a0: QLayout | None)#

setLayoutDirection(self, direction: Qt.LayoutDirection)#

setLocale(self, locale: QLocale)#

setMask(self, a0: QBitmap)#
setMask(self, a0: QRegion) → None

setMaximumHeight(self, maxh: int)#

setMaximumSize(self, maxw: int, maxh: int)#
setMaximumSize(self, s: QSize) → None

setMaximumWidth(self, maxw: int)#

setMinimumHeight(self, minh: int)#

setMinimumSize(self, minw: int, minh: int)#
setMinimumSize(self, s: QSize) → None

setMinimumWidth(self, minw: int)#

setModal(self, modal: bool)#

setMouseTracking(self, enable: bool)#

setObjectName(self, name: str | None)#

setPalette(self, a0: QPalette)#

setParent(self, parent: QWidget | None)#
setParent(self, parent: QWidget | None, f: Qt.WindowFlags | Qt.WindowType) → None

setProperty(self, name: str | None, value: Any) → bool#

setResult(self, r: int)#

setShortcutAutoRepeat(self, id: int, enabled: bool = True)#

setShortcutEnabled(self, id: int, enabled: bool = True)#

setSizeGripEnabled(self, a0: bool)#

setSizeIncrement(self, w: int, h: int)#
setSizeIncrement(self, s: QSize) → None

setSizePolicy(self, a0: QSizePolicy)#
setSizePolicy(self, hor: QSizePolicy.Policy, ver: QSizePolicy.Policy) → None

setStatusTip(self, a0: str | None)#

setStyle(self, a0: QStyle | None)#

setStyleSheet(self, styleSheet: str | None)#

setTabOrder(a0: QWidget | None, a1: QWidget | None)#

setTabletTracking(self, enable: bool)#

setToolTip(self, a0: str | None)#

setToolTipDuration(self, msec: int)#

setUpdatesEnabled(self, enable: bool)#

setVisible(self, visible: bool)#

setWhatsThis(self, a0: str | None)#

setWindowFilePath(self, filePath: str | None)#

setWindowFlag(self, a0: Qt.WindowType, on: bool = True)#

setWindowFlags(self, type: Qt.WindowFlags | Qt.WindowType)#

setWindowIcon(self, icon: QIcon)#

setWindowIconText(self, a0: str | None)#

setWindowModality(self, windowModality: Qt.WindowModality)#

setWindowModified(self, a0: bool)#

setWindowOpacity(self, level: float)#

setWindowRole(self, a0: str | None)#

setWindowState(self, state: Qt.WindowStates | Qt.WindowState)#

setWindowTitle(self, a0: str | None)#

setupUi(Dialog)#

sharedPainter(self) → QPainter | None#

show(self)#

showEvent(self, a0: QShowEvent | None)#

showFullScreen(self)#

showMaximized(self)#

showMinimized(self)#

showNormal(self)#

signalsBlocked(self) → bool#

size(self) → QSize#

sizeHint(self) → QSize#

sizeIncrement(self) → QSize#

sizePolicy(self) → QSizePolicy#

stackUnder(self, a0: QWidget | None)#

startTimer(self, interval: int, timerType: Qt.TimerType = Qt.CoarseTimer) → int#

staticMetaObject = <PyQt5.QtCore.QMetaObject object>#

statusTip(self) → str#

style(self) → QStyle | None#

styleSheet(self) → str#

tabletEvent(self, a0: QTabletEvent | None)#

testAttribute(self, attribute: Qt.WidgetAttribute) → bool#

thread(self) → QThread | None#

timerEvent(self, a0: QTimerEvent | None)#

toolTip(self) → str#

toolTipDuration(self) → int#

tr(self, sourceText: str | None, disambiguation: str | None = None, n: int = -1) → str#

underMouse(self) → bool#

ungrabGesture(self, type: Qt.GestureType)#

unsetCursor(self)#

unsetLayoutDirection(self)#

unsetLocale(self)#

update(self)#
update(self, a0: QRect) → None
update(self, a0: QRegion) → None
update(self, ax: int, ay: int, aw: int, ah: int) → None

updateGeometry(self)#

updateMicroFocus(self)#

updatesEnabled(self) → bool#

visibleRegion(self) → QRegion#

whatsThis(self) → str#

wheelEvent(self, a0: QWheelEvent | None)#

width(self) → int#

widthMM(self) → int#

winId(self) → PyQt5.sip.voidptr#

window(self) → QWidget | None#

windowFilePath(self) → str#

windowFlags(self) → Qt.WindowFlags#

windowHandle(self) → QWindow | None#

windowIcon(self) → QIcon#

windowIconChanged#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

windowIconText(self) → str#

windowIconTextChanged#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

windowModality(self) → Qt.WindowModality#

windowOpacity(self) → float#

windowRole(self) → str#

windowState(self) → Qt.WindowStates#

windowTitle(self) → str#

windowTitleChanged#

int = …, arguments: Sequence = …) -> PYQT_SIGNAL

Type:: pyqtSignal(*types, name
Type:: str = …, revision

windowType(self) → Qt.WindowType#

x(self) → int#

y(self) → int#

Reference guide#

openalea.color.colormap module#

openalea.color.py_color module#

openalea.csv.pycsv module#

openalea.data.array.arrays module#

openalea.data.data module#

openalea.data.dict.dicts module#

openalea.data.list.lists module#

openalea.data.set.sets module#

openalea.data.tuple.tuples module#

openalea.file.files module#

openalea.functional.functional module#

openalea.math.maths module#

openalea.model.models module#

openalea.pickling.pickling module#

openalea.plotools.plotable module#

openalea.python.python module#

openalea.spatial.distribGen module#

openalea.stand.stand_modelling module#

openalea.string.strings module#

openalea.system.systemnodes module#

openalea.system.ui_vprint module#

openalea.system.vprint module#

This Page

Reference guide #

`openalea.color.colormap` module#

`openalea.color.py_color` module#

`openalea.csv.pycsv` module #

`openalea.data.array.arrays` module#

`openalea.data.data` module#

`openalea.data.dict.dicts` module#

`openalea.data.list.lists` module#

`openalea.data.set.sets` module#

`openalea.data.tuple.tuples` module#

`openalea.file.files` module#

`openalea.functional.functional` module#

`openalea.math.maths` module #

`openalea.model.models` module#

`openalea.pickling.pickling` module#

`openalea.plotools.plotable` module#

`openalea.python.python` module#

`openalea.spatial.distribGen` module#

`openalea.stand.stand_modelling` module#

`openalea.string.strings` module #

`openalea.system.systemnodes` module#

`openalea.system.ui_vprint` module#

`openalea.system.vprint` module#