solarspatialtools.field.compute_predicted_position
- solarspatialtools.field.compute_predicted_position(dfs, pos_utm, ref, cld_vecs=None, mode='coherence', ndownsel=8, navgs=5, coh_limit=0.6, freq_limit=0.02, delay_method='multi')
Compute the predicted position of a combiner based upon the cloud movement. Requires two separate inputs with different CMV directions. Inputs are provided as lists containing the data about the two different cases. For reference on the method, refer to [1].
Parameters
- dfslist[pandas.DataFrame]
Time series of the data. Columns are the points, rows are the time.
- pos_utmpandas.DataFrame
The known positions of all sensors. Must be in UTM (x,y) coordinates. Index should match the columns of df
- refstr
The name of the reference point. Must be a column in df and a row in pos_utm.
- cld_vecsnp.ndarray
The cloud motion vectors, [[Vx1, Vy1], [Vx2, Vy2]]
- modestr
The method for downselecting the points to use for computing the position. Options are ‘coherence’, ‘global_coherence’, ‘distance’, and ‘all’. ‘coherence’ will choose the n best points for each CMV that experience the best coherence. ‘global_coherence’ computes an orthogonal sum of coherence for both CMV’s and chooses the same best n points across both. Default is ‘coherence’.
- ndownselint
The number of points to downselect to. Default is 8.
- navgsint
The number of averages to use when computing the transfer function. Affects both the coherence and the frequency resolution. Default is 5. see solarspatialtools.signalproc.averaged_tf for more information.
- coh_limitfloat
The minimum coherence required for computing the delay. Default is 0.6. See solarspatialtools.signalproc.tf_delay for more information.
- freq_limitfloat
The maximum frequency that will be used when computing the delay. See solarspatialtools.signalproc.tf_delay for more info.
- delay_methodstr
The method for computing the delay. Options are ‘fit’ and ‘multi’.
Returns
- posnp.ndarray
The predicted position of the combiner (X,Y) in the coordinate system of pos_utm
- fulldatalist[pandas.DataFrame]
The full data set for each of the two cases. Each element of the list is a pandas.DataFrame with columns ‘cloud_dist’, ‘delay’, and ‘coh’ and an index matching pos_utm. Cloud_dist is the distances implied by the cloud motion for that particular time along the cloud motion dir. Delay is the raw value of tf delay for each of the points relative to the reference. coh is the average coherence for that transfer function.
References