User Manual 4.0 Events detection: Presentation - Historique des versions

Admin le 21 février 2018 à 14:15

2018-02-21T14:15:59Z

Admin : /* Contents */

2018-02-21T08:56:31Z

Contents

@@ Ligne 422 : / Ligne 422 : @@
 ==== Interfaces events detection ====
-|=Interface|=Summary|=Javadoc
+{| class="wikitable"
-| EventDetector|This interface represents an event finder.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/EventDetector.html EventDetector ]
+|-
-| CodingEventDetector|This interface is an extended event finder, that is needed to create CodedEvent and Phenomenon instances.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/CodingEventDetector.html CodingEventDetector]
+! scope="col"| Interface
-| MultiEventDetector|This interface represents an event finder in multi propagation case.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/multi/MultiEventDetector.html MultiEventDetector]
+! scope="col"| Summary
-| MultiCodingEventDetector|This interface is an extended event finder, that is needed to create CodedEvent and Phenomenon instances in multi propagation case.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/multi/MultiCodingEventDetector.html MultiCodingEventDetector]
+! scope="col"| Javadoc
 === Classes ===
 ==== Classes containing the general functions to detect events ====
-|=Classe|=Summary|=Javadoc
+{| class="wikitable"
-| AbstractDetector|This class contains the methods shared by all events detectors.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/AbstractDetector.html AbstractDetector]
+|-
-| MultiAbstractDetector|This class contains the methods shared by all events detectors in multi propagation case.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/multi/MultiAbstractDetector.html MultiAbstractDetector]
+! scope="col"| Class
-| AdaptedEventDetector|This class adapts Patrius event detectors to math EventHandler object.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/AdaptedEventDetector.html AdaptedEventDetector]
+! scope="col"| Summary
-| AdaptedMonoEventDetector|This class adapts Patrius mono event detectors to math EventHandler object in multi propagation case.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/multi/AdaptedMonoEventDetector.html AdaptedEventDetector]
+! scope="col"| Javadoc
-| AdaptedMultiEventDetector|This class adapts Patrius multi event detectors to math EventHandler object in multi propagation case.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/multi/AdaptedMultiEventDetector.html AdaptedEventDetector]
+|-
-| CombinedPhenomenaDetector|This class handles events representing the combination of two boolean phenomena.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/CombinedPhenomenaDetector.html CombinedPhenomenaDetector]
+| AbstractDetector
-| NthOccurrenceDetector|This class represents an event detector that will detected a certain occurrence of a specified event.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/events/NthOccurrenceDetector.html NthOccurrenceDetector]
+|This class contains the methods shared by all events detectors.
 ==== Classes for the generation of lists of events and phenomena ====
-|=Classe|=Summary|=Javadoc
+{| class="wikitable"
-| CodedEvent|This class implements coded events (a light and simple representation of events as generated by Patrius event detectors ).|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/CodedEvent.html CodedEvent]
+|-
-| CodedEventsList|This class implements a list of coded events.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/CodedEventsList.html CodedEventsList]
+! scope="col"| Class
-| Phenomenon|This class implements the notion of a phenomenon : a state defined by a starting event and an ending event.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/Phenomenon.html Phenomenon]
+! scope="col"| Summary
-| PhenomenaList|This class implements a list of coded events.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/PhenomenaList.html PhenomenaList]
+! scope="col"| Javadoc
-| CodedEventsLogger|This class builds instances of CodedEventsList and PhenomenaList during a propagation.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/CodedEventsLogger.html CodedEventsLogger]
+|-
-| MultiCodedEventsLogger|This class builds instances of CodedEventsList and PhenomenaList during a propagation in multi propagation case.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/multi/MultiCodedEventsLogger.html MultiCodedEventsLogger]
+| CodedEvent
-| GenericCodingEventDetector|This class is a generic implementation of the CodingEventDetector interface, mainly for testing purposes - but it is usable as is.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/GenericCodingEventDetector.html GenericCodingEventDetector]
+|This class implements coded events (a light and simple representation of events as generated by Patrius event detectors ).
-| MultiGenericCodingEventDetector|This class is a generic implementation of the CodingEventDetector interface in multi propagation case, mainly for testing purposes - but it is usable as is.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/multi/MultiGenericCodingEventDetector.html MultiGenericCodingEventDetector]
+|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/events/CodedEvent.html CodedEvent]
 [[Category:User_Manual_4.0_Mission]]

Admin : /* Javadoc */

2018-02-21T08:52:45Z

Javadoc

← Version précédente		Version du 21 février 2018 à 08:52
Ligne 13 :		Ligne 13 :
	The following packages are related to events detections in mono and multi propagation context:		The following packages are related to events detections in mono and multi propagation context:

	\|=Library\|=Javadoc		{\| class="wikitable"
	\|Patrius \|[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/package-summary.html Package fr.cnes.sirius.patrius.propagation.event]		\|-
	\|Patrius \|[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/math/ode/events/package-summary.html Package fr.cnes.sirius.patrius.math.ode.events]		! scope="col"\| Library
	\|Patrius \|[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/events/package-summary.html Package fr.cnes.sirius.patrius.events]		! scope="col"\| Javadoc
	\|Patrius \|[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/multi/package-summary.html Package fr.cnes.sirius.patrius.propagation.events.multi]		\|-
			\|Patrius
			\|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/package-summary.html Package fr.cnes.sirius.patrius.propagation.event]
			\|-
			\|Patrius
			\|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/math/ode/events/package-summary.html Package fr.cnes.sirius.patrius.math.ode.events]
			\|-
			\|Patrius
			\|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/events/package-summary.html Package fr.cnes.sirius.patrius.events]
			\|-
			\|Patrius
			\|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/multi/package-summary.html Package fr.cnes.sirius.patrius.propagation.events.multi]
			\|}

	=== Links ===		=== Links ===

Admin : /* Combination of boolean phenomena */

2018-02-19T12:39:28Z

Combination of boolean phenomena

← Version précédente		Version du 19 février 2018 à 12:39
Ligne 374 :		Ligne 374 :

	The user simply has to provide the following parameters :		The user simply has to provide the following parameters :
	1. First detector and the way to use it (g is positive or negative during the phenomena to combine)		#First detector and the way to use it (g is positive or negative during the phenomena to combine)
	2. Second detector and the way to use it		#Second detector and the way to use it
	3. How to combine the phenomenom : both are during phenomena (will be detected as the minimum of the two g function) or at least one (will be detected as the maximum of the two g function) is during phenomena		#How to combine the phenomenom : both are during phenomena (will be detected as the minimum of the two g function) or at least one (will be detected as the maximum of the two g function) is during phenomena

	Once a new detector have been created in this way, it is possible to combine it with another one and so on.		Once a new detector have been created in this way, it is possible to combine it with another one and so on.
Ligne 405 :		Ligne 405 :
	new CentralBodyMaskCircularFOVDetector(targetPVP, targetRadius, spheroEarth, false, fovDir, halfAp, MAXCHK, THRS);		new CentralBodyMaskCircularFOVDetector(targetPVP, targetRadius, spheroEarth, false, fovDir, halfAp, MAXCHK, THRS);
	</syntaxhighlight>		</syntaxhighlight>


	== Contents ==		== Contents ==

Admin : /* Examples */

2018-02-19T12:38:21Z

Examples

← Version précédente		Version du 19 février 2018 à 12:38
Ligne 310 :		Ligne 310 :
	==== Examples ====		==== Examples ====

	The CodedEvent instances and Phenomenon instances are meant to be produced using :		The CodedEvent instances and Phenomenon instances are meant to be produced using :<br>
	- CodingEventDetector implementations that provide information about events and phenomena,		- CodingEventDetector implementations that provide information about events and phenomena,<br>
	- a CodingEventsLogger, that uses the CodingEventDetector instances to build the events and phenomena.		- a CodingEventsLogger, that uses the CodingEventDetector instances to build the events and phenomena.

Admin : /* Examples */

2018-02-19T12:38:00Z

Examples

← Version précédente		Version du 19 février 2018 à 12:38
Ligne 316 :		Ligne 316 :
	For example, if we want to create a list of CodedEvent objects using a detector of nodes (ascending and descending orbital nodes):		For example, if we want to create a list of CodedEvent objects using a detector of nodes (ascending and descending orbital nodes):

	1.Create a new EventDetector (in this case a NodeDetector):		1. Create a new EventDetector (in this case a NodeDetector):

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">

Admin : /* Examples */

2018-02-19T12:37:44Z

Examples

← Version précédente		Version du 19 février 2018 à 12:37
Ligne 316 :		Ligne 316 :
	For example, if we want to create a list of CodedEvent objects using a detector of nodes (ascending and descending orbital nodes):		For example, if we want to create a list of CodedEvent objects using a detector of nodes (ascending and descending orbital nodes):

	#Create a new EventDetector (in this case a NodeDetector):		1.Create a new EventDetector (in this case a NodeDetector):

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 326 :		Ligne 326 :
	</syntaxhighlight>		</syntaxhighlight>

	#Create a new generic coding event detector:		2. Create a new generic coding event detector:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 340 :		Ligne 340 :
	</syntaxhighlight>		</syntaxhighlight>

	#Create a new CodedEventsLogger and use the <code> monitorDetector </code> function on the new CodedEventsLogger:		3. Create a new CodedEventsLogger and use the <code> monitorDetector </code> function on the new CodedEventsLogger:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 350 :		Ligne 350 :
	</syntaxhighlight>		</syntaxhighlight>

	#Add the EventDetector to the propagator:		4. Add the EventDetector to the propagator:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 358 :		Ligne 358 :
	</syntaxhighlight>		</syntaxhighlight>

	#Start the propagation:		5. Start the propagation:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">

Admin : /* Generating coded events and phenomena */

2018-02-19T12:36:30Z

Generating coded events and phenomena

← Version précédente		Version du 19 février 2018 à 12:36
Ligne 316 :		Ligne 316 :
	For example, if we want to create a list of CodedEvent objects using a detector of nodes (ascending and descending orbital nodes):		For example, if we want to create a list of CodedEvent objects using a detector of nodes (ascending and descending orbital nodes):

	1. Create a new EventDetector (in this case a NodeDetector):		#Create a new EventDetector (in this case a NodeDetector):

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 326 :		Ligne 326 :
	</syntaxhighlight>		</syntaxhighlight>

	2. Create a new generic coding event detector:		#Create a new generic coding event detector:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 340 :		Ligne 340 :
	</syntaxhighlight>		</syntaxhighlight>

	3. Create a new CodedEventsLogger and use the <code> monitorDetector </code> function on the new CodedEventsLogger:		#Create a new CodedEventsLogger and use the <code> monitorDetector </code> function on the new CodedEventsLogger:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 350 :		Ligne 350 :
	</syntaxhighlight>		</syntaxhighlight>

	4. Add the EventDetector to the propagator:		#Add the EventDetector to the propagator:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">
Ligne 358 :		Ligne 358 :
	</syntaxhighlight>		</syntaxhighlight>

	5. Start the propagation:		#Start the propagation:

	<syntaxhighlight lang="java">		<syntaxhighlight lang="java">

Admin le 19 février 2018 à 12:33

2018-02-19T12:33:14Z

← Version précédente		Version du 19 février 2018 à 12:33
Ligne 1 :		Ligne 1 :
	\\



	== Introduction ==		== Introduction ==
	=== Scope ===		=== Scope ===

Admin le 19 février 2018 à 11:25

2018-02-19T11:25:53Z

← Version précédente		Version du 19 février 2018 à 11:25
Ligne 444 :		Ligne 444 :
	\| GenericCodingEventDetector\|This class is a generic implementation of the CodingEventDetector interface, mainly for testing purposes - but it is usable as is.\|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/GenericCodingEventDetector.html GenericCodingEventDetector]		\| GenericCodingEventDetector\|This class is a generic implementation of the CodingEventDetector interface, mainly for testing purposes - but it is usable as is.\|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/GenericCodingEventDetector.html GenericCodingEventDetector]
	\| MultiGenericCodingEventDetector\|This class is a generic implementation of the CodingEventDetector interface in multi propagation case, mainly for testing purposes - but it is usable as is.\|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/multi/MultiGenericCodingEventDetector.html MultiGenericCodingEventDetector]		\| MultiGenericCodingEventDetector\|This class is a generic implementation of the CodingEventDetector interface in multi propagation case, mainly for testing purposes - but it is usable as is.\|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/events/multi/MultiGenericCodingEventDetector.html MultiGenericCodingEventDetector]

			[[Category:User_Manual_4.0_Mission]]

← Version précédente		Version du 21 février 2018 à 14:15
Ligne 47 :		Ligne 47 :

	The following classes are duplicated from mono satellite context in order to create a list of events detected :		The following classes are duplicated from mono satellite context in order to create a list of events detected :
	* [{{~~PathCurrentJavaDoc~~}}//fr/cnes/sirius/patrius/events/multi/MultiCodedEventsLogger.html MultiCodedEventsLogger]		* [{{JavaDoc4.0}}//fr/cnes/sirius/patrius/events/multi/MultiCodedEventsLogger.html MultiCodedEventsLogger]
	* [{{~~PathCurrentJavaDoc~~}}//fr/cnes/sirius/patrius/events/multi/MultiCodingEventDetector.html MultiCodingEventDetector]		* [{{JavaDoc4.0}}//fr/cnes/sirius/patrius/events/multi/MultiCodingEventDetector.html MultiCodingEventDetector]
	* [{{~~PathCurrentJavaDoc~~}}//fr/cnes/sirius/patrius/events/multi/MultiEventsLogger.html MultiEventsLogger]		* [{{JavaDoc4.0}}//fr/cnes/sirius/patrius/events/multi/MultiEventsLogger.html MultiEventsLogger]
	* [{{~~PathCurrentJavaDoc~~}}//fr/cnes/sirius/patrius/events/multi/MultiGenericCodingEventDetector.html MultiGenericCodingEventDetector]		* [{{JavaDoc4.0}}//fr/cnes/sirius/patrius/events/multi/MultiGenericCodingEventDetector.html MultiGenericCodingEventDetector]

	== Features Description ==		== Features Description ==
Ligne 62 :		Ligne 62 :

	A new detector class should implements :		A new detector class should implements :
	* [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/EventDetector.html EventDetector interface] in case of [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/Propagator.html mono satellite propagation] or [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/MultiPropagator.html multi satellite propagation].		* [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/EventDetector.html EventDetector interface] in case of [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/Propagator.html mono satellite propagation] or [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/MultiPropagator.html multi satellite propagation].
	* [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/multi/MultiEventDetector.html MultiEventDetector interface] in case of [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/MultiPropagator.html multi satellite propagation].		* [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/multi/MultiEventDetector.html MultiEventDetector interface] in case of [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/MultiPropagator.html multi satellite propagation].

	'''''Construction of a detector'''''<br>		'''''Construction of a detector'''''<br>
Ligne 78 :		Ligne 78 :
	The returned action of the function eventOccurred could be set by user or defined by default.<br>		The returned action of the function eventOccurred could be set by user or defined by default.<br>

	The function eventOccurred is common to all [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/EventDetector.html EventDetector] classes (respectively [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/multi/MultiEventDetector.html MultiEventDetector]) and its purpose is to handle an event and to choose what to do next ; this method is called when the integrator has accepted a step ending exactly on a sign change of the switching function, and it allows the user to choose which action will take place after the event (the simulation could be stopped, the propagator could reset its initial state or its initial derivative state ...).		The function eventOccurred is common to all [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/EventDetector.html EventDetector] classes (respectively [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/multi/MultiEventDetector.html MultiEventDetector]) and its purpose is to handle an event and to choose what to do next ; this method is called when the integrator has accepted a step ending exactly on a sign change of the switching function, and it allows the user to choose which action will take place after the event (the simulation could be stopped, the propagator could reset its initial state or its initial derivative state ...).
	Plus, this method is up to determine if the detector used has to be removed after the event detection : in the above example of <code> NodeDetector </code>, the action taking place after the event is set to action_at_raising_node in the case of an ascending node detection. If one has decided to remove the detector at such detection, the attribute shouldBeRemoved will be set to remove_at_ascending_node which is true by construction, the case of descending node is similar.		Plus, this method is up to determine if the detector used has to be removed after the event detection : in the above example of <code> NodeDetector </code>, the action taking place after the event is set to action_at_raising_node in the case of an ascending node detection. If one has decided to remove the detector at such detection, the attribute shouldBeRemoved will be set to remove_at_ascending_node which is true by construction, the case of descending node is similar.

Ligne 129 :		Ligne 129 :

	It also exists multi events detectors applied on several states. These detectors can only be used in multi propagation case.		It also exists multi events detectors applied on several states. These detectors can only be used in multi propagation case.
	Notice that some detectors that implies several satellite coul be used in multi or mono satellite context ; ([{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/events/sensor/SatToSatMutualVisibilityDetector.html SatToSatMutualVisibilityDetector], [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/ThreeBodiesAngleDetector.html ThreeBodiesAngleDetector] or [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/ExtremaThreeBodiesAngleDetector.html ExtremaThreeBodiesAngleDetector])		Notice that some detectors that implies several satellite coul be used in multi or mono satellite context ; ([{{JavaDoc4.0}}/fr/cnes/sirius/patrius/events/sensor/SatToSatMutualVisibilityDetector.html SatToSatMutualVisibilityDetector], [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/ThreeBodiesAngleDetector.html ThreeBodiesAngleDetector] or [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/ExtremaThreeBodiesAngleDetector.html ExtremaThreeBodiesAngleDetector])

	All these event detectors can be used [MIS_EVT_Home#HMultiEventDetection directly] or as [MIS_EVT_Home#HGeneratingcodedeventsandphenomena coded events].		All these event detectors can be used [MIS_EVT_Home#HMultiEventDetection directly] or as [MIS_EVT_Home#HGeneratingcodedeventsandphenomena coded events].
Ligne 136 :		Ligne 136 :
	==== Nth occurrence detector ====		==== Nth occurrence detector ====

	The [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/events/NthOccurrenceDetector.html NthOccurrenceDetector] is a detector that detects the nth occurrence of an underlying event detector.<br>		The [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/events/NthOccurrenceDetector.html NthOccurrenceDetector] is a detector that detects the nth occurrence of an underlying event detector.<br>
	However the <code>eventOccurred()</code> method is triggered at every event of the underlying detector. As a result, the behaviour of this detector is the following:		However the <code>eventOccurred()</code> method is triggered at every event of the underlying detector. As a result, the behaviour of this detector is the following:
	* Before and after the nth occurrence, the eventOccurred() method returns <code>Action.CONTINUE</code>.		* Before and after the nth occurrence, the eventOccurred() method returns <code>Action.CONTINUE</code>.

User Manual 4.0 Events detection: Presentation - Historique des versions

Admin le 21 février 2018 à 14:15

Admin : /* Contents */

Admin : /* Javadoc */

Admin : /* Combination of boolean phenomena */

Admin : /* Examples */

Admin : /* Examples */

Admin : /* Examples */

Admin : /* Generating coded events and phenomena */

Admin le 19 février 2018 à 12:33

Admin le 19 février 2018 à 11:25

Admin : /* Contents */

Admin : /* Javadoc */

Admin : /* Combination of boolean phenomena */

Admin : /* Examples */

Admin : /* Examples */

Admin : /* Examples */

Admin : /* Generating coded events and phenomena */