Documenting #67
BeamDet документация
| Status: | Открыта | Start date: | 07/25/2017 | |
|---|---|---|---|---|
| Priority: | Низкий | Due date: | ||
| Assignee: | Mikhail Kozlov | % Done: | 0% | |
| Category: | BeamDet | |||
| Target version: | v-0.4 |
Description
Необходимо написать текст документации про BeamDet. см. http://er.jinr.ru/neurad.html
Документация должна включать в себя:
1) Абстракт того, зачем нужен BeamDet
2) Текущую структуру геометрии
3) В симуляции написать, что имеет два типа поинтов. И что про то, что сигнал на проволочке, собирается с некоторого геометрического объема
4) Особенности диджитизации. Как размываем параметры.
5) Алгоритм поиска трека
6) Алгоритм идентификации параметров иона на мишени. Разделение dEvsTOF.
7) Расказ про то, как работают ERIonGenerator, ERIonMixGenerator. Словами описать возможные способы конфигурации.Как разыгрываются вероятности.
Желательно все снабжать картинками, которые вы строили для анализа, разделяемости
History
#1 Updated by Vitaliy Schetinin over 7 years ago
- Description updated (diff)
- Assignee set to Mikhail Kozlov
#2 Updated by Sergey Belogurov over 7 years ago
Коллеги! документацию лучше делать сразу на английском. Что и насколько подробно писать, всегда готов обсудить.
#3 Updated by Mikhail Kozlov about 7 years ago
Насколько подробным должно быть документирование?
Нужно ли в описании этого детектора объяснять что такое симуляция, диджитизация, реконструкция и т.д. в общем случае или только особенности для данной сборки?
И насколько много вставок кода, описаний реализованных интерфейсов делать?
#4 Updated by Sergey Belogurov about 7 years ago
Миша, извините, что тне сразу отвечаю . Документация пишется как для тех, кто только начинает работать, так и для тех, кто знаком с ЕР и хочет что-то уточнить по вашему детектору. Во втором случае человек предполагается, что знает, куда лезть в код за ответом на тот или иной йвопрос и в документации нужны лишь какие-то общие guidelines. По этому случаю лучше подождать ответ Виталика.
Что касается первого случая, Человек должен, не глядя в код, понять 1) что именно моделируется: геометрия, вещества (можно ссылку на медиа.гео), каты, учтенные и неучтенные эффекты 2) какие ручки есть у пользоывателя в распоряжении. Геометрию надо показать понятно. Если пока что не научились делать это из рут, сделайте отдельный рисунок в профиль любым граф редактором. Учтенные эффекты в MWPC - рождение дельта-электронов, следовательно ненулевой размер области ионизации, в.т.ч. расползание на соседние проволочки. Неучтенные эффекты в MWPC: снижение отклика, когда ионизация имеет место вблизи проволочки, диффузия ионизационных электронов. В TOF - тушение сцинтилляции в зависимости от плотности ионизации (закон Биркса) учтено, но не валидированно для конкретного пластика. Еще надо рассказать о возможностях микс генератора и о сути процедуры восстановления и возможности идентификации ионов. Вставками кода злоупотреблять не надо, только если очень хочется.