pvfactors.geometry.base.BaseSide

class pvfactors.geometry.base.BaseSide(list_segments=None)[source]

A side represents a fixed collection of PV segments objects that should all be collinear, with the same normal vector

__init__(list_segments=None)[source]

Create a side geometry.

Parameters: list_segments (list of PVSegment, optional) – List of PV segments for side (Default = None)

Methods

`__init__`([list_segments])	Create a side geometry.
`cast_shadow`(linestring)	Cast shadow on Side using linestring: will rearrange the PV surfaces between the shaded and illuminated collections of the segments.
`cut_at_point`(point)	Cut Side at point if the side contains it.
`from_linestring_coords`(coords[, shaded, ...])	Create a Side with a single PV surface, or multiple discretized identical ones.
`get_param_weighted`(param)	Get the parameter from the side's surfaces, after weighting by surface length.
`get_param_ww`(param)	Get the parameter from the side's surfaces with weight, i.e. after multiplying by the surface lengths.
`merge_shaded_areas`()	Merge shaded areas of all PV segments
`plot`(ax[, color_shaded, color_illum, with_index])	Plot the surfaces in the Side object.
`update_params`(new_dict)	Update surface parameters in the Side.

Attributes

`all_surfaces`	List of all surfaces in the Side object.
`n_surfaces`	Number of surfaces in the Side object.
`n_vector`	Normal vector of the Side.
`shaded_length`	Shaded length of the Side.
`surface_indices`	List of all surface indices in the Side object.