pvfactors.geometry.base.ShadeCollection

class pvfactors.geometry.base.ShadeCollection(list_surfaces=None, shaded=None, param_names=None)[source]

A group of PVSurface objects that all have the same shading status. The PV surfaces are not necessarily contiguous or collinear.

__init__(list_surfaces=None, shaded=None, param_names=None)[source]

Initialize shade collection.

Parameters:

list_surfaces (list, optional) – List of PVSurface object (Default = None)
shaded (bool, optional) – Shading status of the collection. If not specified, will be derived from list of surfaces (Default = None)
param_names (list of str, optional) – Names of the surface parameters, eg reflectivity, total incident irradiance, temperature, etc. (Default = None)

Methods

`__init__`([list_surfaces, shaded, param_names])	Initialize shade collection.
`add_linestring`(linestring[, normal_vector])	Add PV surface to the collection using a linestring
`add_pvsurface`(pvsurface)	Add PV surface to the collection.
`cut_at_point`(point)	Cut collection at point if the collection contains it.
`distance`(args, *kwargs)	Distance between the collection and another geometry.
`dwithin`(args, *kwargs)	Check if the collection is within a certain distance of another geometry.
`from_linestring_coords`(coords, shaded[, ...])	Create a shade collection with a single PV surface.
`get_param_weighted`(param)	Get the parameter from the collection's surfaces, after weighting by surface length.
`get_param_ww`(param)	Get the parameter from the collection's surfaces with weight, i.e. after multiplying by the surface lengths.
`merge_surfaces`()	Merge all surfaces in the shade collection into one contiguous surface, even if they're not contiguous, by using bounds.
`plot`(ax[, color, with_index])	Plot the surfaces in the shade collection.
`remove_linestring`(linestring)	Remove linestring from shade collection.
`update_params`(new_dict)	Update surface parameters in the collection.

Attributes

`geometry`	Return a Shapely GeometryCollection built from the current surfaces.
`is_empty`	Check if the collection is empty.
`length`	Convenience property to get the total length of all lines in the collection.
`n_surfaces`	Number of surfaces in collection.
`n_vector`	Unique normal vector of the shade collection, if it exists.
`surface_indices`	Indices of the surfaces in the collection.